From 413e79f2e1a942aa7b5c3a574ab8d60346082a19 Mon Sep 17 00:00:00 2001
From: Nenotriple <70049990+Nenotriple@users.noreply.github.com>
Date: Mon, 27 Nov 2023 06:34:17 -0800
Subject: [PATCH] Update README.md

---
 README.md | 56 +++++++++++++++++++++++++++++--------------------------
 1 file changed, 30 insertions(+), 26 deletions(-)

diff --git a/README.md b/README.md
index c976e0b..6eaccd1 100644
--- a/README.md
+++ b/README.md
@@ -14,24 +14,23 @@ Display an image and text file side-by-side for easy manual caption editing.
 
 # 💡 Tips and Features
 
-- Hotkeys:
+- Shortcuts:
   - `ALT+Left/Right`: Quickly move between img-txt pairs.
   - `Del`: Send the current pair to a local trash folder.
   - `ALT`: Cycle through auto-suggestions.
   - `TAB`: Insert the highlighted suggestion.
+  - `CRTL+F`: Highlight all duplicate words. 
   - `CTRL+S`: Save the current text file.
   - `CTRL+Z` / `CTRL+Y`: Undo/Redo.
-  - `CRTL+F`: Highlight all duplicate words.
+  - `Middle-click`: a token to quickly delete it.
 
 - Tips:
   - `Highlight duplicates` by selecting text.
-  - `Autocomplete Suggestions` while you type using Danbooru tags.
   - Enable `List View` to display text in a vertical list format.
   - Enable `Big Comma Mode` for more visual separation between captions.
-  - Middle-click a token to quickly delete it.
-  - Right-click the directory button to copy the path.
-  - Right-click the image/text for a context menu.
   - Blank text files can be created for images without any matching files when loading a directory.
+  - `Autocomplete Suggestions` while you type using Danbooru/Anime tags, the English Dictionary, or both. 
+  - Running 'Edit Custom Suggestions' will create the file 'my_tags.csv' where you can add your own words to the suggestion dictionary.
 
 - Text Tools:
   - `Batch Token Delete`: View all tokens in a directory as a list, and quickly delete them.
@@ -57,34 +56,39 @@ You must have **Python 3.10+** installed to the system PATH.
 
 The `pillow` library will be downloaded and installed *(if not already available)* upon launch.
 
-The `danbooru.csv` file will be downloaded *(if not already available)* upon launch.
+The `danbooru.csv` and `dictionary.csv` files will be downloaded *(if not already available)* upon launch.
 
 # 📜 Version History
 
-[v1.77 changes:](https://github.com/Nenotriple/img-txt_viewer/releases/tag/v1.77)
+[v1.78 changes:](https://github.com/Nenotriple/img-txt_viewer/releases/tag/v1.78)
   - New:
-    - `List View`: Display text files in a list format. Text is always saved in the standard single-line CSV format.
-    - `Always on Top`: Enable this to keep the window in focus.
-    - `Highlight All Duplicates`: Highlight all matching words in the text box.
-    - `Delete entire tokens`: By middle-clicking them.
-    - `Text Context menu`
-    - `Image Context menu`
-    - Enable or disable highlighting duplicate words when selecting text. _(Default = On)_
-    - You can now swap the image and text/control positions.
-    - Various UI tweaks, the biggest change being: Image scaling is now more flexible.
+    - You can now use the English dictionary as a suggestion library while you type.
+      - Enable this from: Options > Suggestion Dictionary > English Dictionary
+      - Just like the danbooru.csv file, this dictionary can be downloaded from the script version.
+      - Over 20,000 typos for just over 8,000 words also match the correct spelling while typing.
+      - You can also use both anime tags and the English dictionary at the same time. _(Can be slow)_
+    - `Custom Suggestions:` You can now define custom tags that will be used for autocomplete suggestions.
+      - Run the command from: Options > Edit Custom Suggestions
+      - Running this command will create a file called "my_tags.csv" if it doesn't already exist, then open it up for you to edit.
+      - Running the command again after saving "my_tags.csv" will refresh the dictionary with your changes.
 
 <br>
 
   - Fixed:
-    - When highlighting words: Any _selected_ words longer than 3 characters would be _highlighted_. Now, only exact matches are highlighted.
-    - Window size no longer changes when changing maximum image size.
-    - You can no longer insert a suggestion "inside" an existing token.
-    - Code refactoring for improved cleanliness and maintainability.
+    - Fix autosave for first and last index navigation.
+    - List mode: The cursor is now placed at the end of the text file on a newline when navigating between pairs.
+    - App icon now displays properly in the taskbar.
+    - Further improvements to cursor positioning after inserting a suggestion.
 
-**Batch Delete, v1.02 Changes:**
+**Batch Delete, v1.03 Changes:**
 
- - New:
-   - You can now select multiple tokens then delete them all at once.
+  - New:
+    - Now that text is cleaned within the script, this is a standalone app!
+      - Simply launch the "batch_token_delete.py" script and select a folder to manage text/tags in that folder.
+    - Deleting tags using a "less than or equal to" threshold now displays the affected tags.
+    - A highlight has been added to the buttons/checkboxes.
+
+<br>
 
- - Fixed:
-   - Newlines should be properly handled/deleted now.
+  - Fixed:
+    - The app shares the parent icon, and groups with the main window in the taskbar.