Merge branch 'master' of ssh://armitage.local:2222/alex/mex

README.md

@@ -1,25 +1,32 @@
 # Mex
 
-<ruby>Mex<rt>漫画展開ツール</rt></ruby> is a tool for repacking manga archives (RAR, CBZ, etc.) into a sane directory
+Mex is a tool for repacking manga archives into a sane directory structure for consumptions by viewers like
-structure which can be readily consumed by viewers like [Komga](https://komga.org/),
+[Komga](https://komga.org/), [Kavita](https://www.kavitareader.com/), and many others.
-[Kavita](https://www.kavitareader.com/), and others.
 
 ![](img/mex.png)
 
 ## Requirements
 
-You must have both `7za` / `7z` and `unrar` installed on your system.
+You must have both `7za` / `7z` and `unrar` installed on your system and included in your system `PATH`.
 
 ## Features
 
-*   Extract most compressed formats, handling nested archives 🌮
+*   Process most compressed formats, including nested archives 🌮
-*   Select best quality volumes when duplicates exist 🌶️
+*   Detect best quality volumes in the presence of duplicates 🌶️
-*   Optionally rename volumes and pages for consistency 🫔
+*   Rename volumes and pages using templates for consistency 🫔
-*   Exclude any irrelevant garbage files present 🥑
+*   Exclude any irrelevant garbage files present in your archives 🥑
-*   Output loose images or repack to CBZ archives 🌯
+*   Output loose images, CBZ archives, or a combination of both 🌯
 
 ## Usage
 
+To process an archive just pass it on the command line to Mex:
+
+```
+mex my_manga_archive.rar
+```
+
+Additional options can be viewed by running with the `-help` flag:
+
 ```
 Usage: mex <input_path> [<output_dir>]
   -label-book string