Update documentation for v1.1.0

latenitefilms · May 16, 2023 · 96b1423 · 96b1423
1 parent 1abbd78
commit 96b1423
Show file tree

Hide file tree

Showing 10 changed files with 68 additions and 12 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,8 @@
 # Marker Toolbox
 
-Marker Toolbox allows you to import **Vimeo** CSV, **Dropbox Replay** JSON & Email Comments processed with **ChatGPT** into Apple's [Final Cut Pro](https://www.apple.com/final-cut-pro/).
+Marker Toolbox allows you to import **Vimeo** CSV, Wipster CSV, **Dropbox Replay** JSON & **Email Comments** into Apple's [Final Cut Pro](https://www.apple.com/final-cut-pro/).
+
+You can even get OpenAI's **ChatGPT** to help process your Email Comments!
 
 > [:icon-desktop-download: **Click here to buy on the Mac App Store**](https://apps.apple.com/us/app/marker-toolbox/id6446810965)
 

diff --git a/docs/buy.md b/docs/buy.md
@@ -1,8 +1,8 @@
 # Buy on Mac App Store
 
-**Marker Toolbox** is on sale on the macOS App Store for **USD$9.99** for the first month only as a thank-you to our early adopters.
+**Marker Toolbox** was on sale on the macOS App Store for **USD$9.99** for the **first month only** as a thank-you to our early adopters.
 
-Starting on **6th May** the price will increase to **USD$19.99**.
+Starting on **6th May** the price increased to **USD$19.99**.
 
 It's a one-time payment, not subscription.
 

diff --git a/docs/how-to-use.md b/docs/how-to-use.md
@@ -28,7 +28,7 @@ You can export a Dropbox Replay JSON file by clicking the **Export Comments** bu
 
 Once exported, simply drag the JSON file into the drop zone, or click the **Select File** button:
 
-![_Screenshot of Marker Toolbox_](static/vimeo-csv.png)
+![_Screenshot of Marker Toolbox_](static/top-section.png)
 
 Assuming the JSON is correct and valid, the draggable icon on the bottom of the interface will now be green:
 
@@ -48,18 +48,16 @@ This is handy because the individual markers will now be attached to the clips o
 
 ![_Screenshot of Marker Toolbox_](static/timeline-break-apart.png)
 
-Back in the Workflow Extension there are three Marker Options:
+Back in the Workflow Extension if you click the **Settings** button, you can set the Frame Rate and what information is used for the Marker Name:
 
-![_Screenshot of Marker Toolbox_](static/marker-options.png)
+![_Screenshot of Marker Toolbox_](static/top-settings.png)
 
 These settings allow you to add the Author, Replies and Date Added to the Marker name within Final Cut Pro, and the Timeline Index:
 
 ![_Screenshot of Marker Toolbox_](static/marker-options-ticked.png)
 
 These settings should be applied **before** you import a JSON. If you change them, you should import your JSON again for the FCPXML to be updated.
 
-The frame rate you select is the **Settings** panel is also used for JSON files.
-
 ---
 
 ### Convert Vimeo CSV to Markers
@@ -72,7 +70,7 @@ This functionality has been built into [CommandPost](https://commandpost.io) for
 
 Once exported, simply drag a CSV file into the drop zone, or click the **Select File** button:
 
-![_Screenshot of Marker Toolbox_](static/vimeo-csv.png)
+![_Screenshot of Marker Toolbox_](static/top-section.png)
 
 Assuming the CSV is correct and valid, the draggable icon on the bottom of the interface will now be green:
 
@@ -92,17 +90,59 @@ This is handy because the individual markers will now be attached to the clips o
 
 ![_Screenshot of Marker Toolbox_](static/timeline-break-apart.png)
 
-Back in the Workflow Extension there are three Marker Options:
+Back in the Workflow Extension if you click the **Settings** button, you can set the Frame Rate and what information is used for the Marker Name:
 
-![_Screenshot of Marker Toolbox_](static/marker-options.png)
+![_Screenshot of Marker Toolbox_](static/top-settings.png)
 
 These settings allow you to add the Author, Replies and Date Added to the Marker name within Final Cut Pro, and the Timeline Index:
 
 ![_Screenshot of Marker Toolbox_](static/marker-options-ticked.png)
 
 These settings should be applied **before** you import a CSV. If you change them, you should import your CSV again for the FCPXML to be updated.
 
-The frame rate you select is the **Settings** panel is also used for CSV files.
+---
+
+### Convert Wipster CSV to Markers
+
+This feature allows you to easily import a Wipster CSV as markers and titles in Final Cut Pro.
+
+You can export a CSV from Wipster, by clicking the **Download** button on your video, then the **Export CSV** option.
+
+![_Screenshot of Wipster_](static/wipster.png)
+
+You can learn more about exporting CSV files from Wipster [here](https://intercom.help/wipster-support/en/articles/3350841-can-i-print-out-the-comments-on-my-video-or-image).
+
+Once exported, simply drag a CSV file into the drop zone, or click the **Select File** button:
+
+![_Screenshot of Marker Toolbox_](static/top-section.png)
+
+Assuming the CSV is correct and valid, the draggable icon on the bottom of the interface will now be green:
+
+![_Screenshot of Marker Toolbox_](static/drag.png)
+
+You can now drag this green icon into your Final Cut Pro timeline or browser.
+
+If you drag the icon to your timeline, a **Compound Clip** with all your markers will be added:
+
+![_Screenshot of Marker Toolbox_](static/timeline.png)
+
+You can then use the **Clip > Break Apart Clip Items** menubar item to break the Compound Clip into individual markers:
+
+![_Screenshot of Marker Toolbox_](static/break-apart-clip-items.png)
+
+This is handy because the individual markers will now be attached to the clips on the Primary Storyline, so that when you re-arrange clips, those markers will travel with them.
+
+![_Screenshot of Marker Toolbox_](static/timeline-break-apart.png)
+
+Back in the Workflow Extension if you click the **Settings** button, you can set the Frame Rate and what information is used for the Marker Name:
+
+![_Screenshot of Marker Toolbox_](static/top-settings.png)
+
+These settings allow you to add the Author, Replies and Date Added to the Marker name within Final Cut Pro, and the Timeline Index:
+
+![_Screenshot of Marker Toolbox_](static/marker-options-ticked.png)
+
+These settings should be applied **before** you import a CSV. If you change them, you should import your CSV again for the FCPXML to be updated.
 
 ---
 

diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -1,5 +1,19 @@
 # Release Notes
 
+### 1.1.0
+
+**🎉 Released:**
+- 16th May 2023
+
+
+**🥳 New Features:**
+- Added [Wipster](https://www.wipster.io) CSV support. Thanks for suggesting Alister Robbie!
+
+**🔨 Improvements:**
+- The **Process Comments Locally** algorithm now supports time units without spaces in-between (i.e. "1hr10mins"), and shortened time units (i.e. "h", "m", "s", "f"). Thanks for reporting Matthieu Laclau!
+
+---
+
 ### 1.0.1
 
 **🎉 Released:**

diff --git a/docs/static/fresh-install.png b/docs/static/fresh-install.png
diff --git a/docs/static/marker-options.png b/docs/static/marker-options.png
diff --git a/docs/static/top-section.png b/docs/static/top-section.png
diff --git a/docs/static/top-settings.png b/docs/static/top-settings.png
diff --git a/docs/static/vimeo-csv.png b/docs/static/vimeo-csv.png
diff --git a/docs/static/wipster.png b/docs/static/wipster.png