diff --git a/README.md b/README.md index 0d5d099..e3de8a9 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,32 @@ # Mex -Mex漫画展開ツール is a tool for repacking manga archives (RAR, CBZ, etc.) into a sane directory -structure which can be readily consumed by viewers like [Komga](https://komga.org/), -[Kavita](https://www.kavitareader.com/), and others. +Mex is a tool for repacking manga archives into a sane directory structure for consumptions by viewers like +[Komga](https://komga.org/), [Kavita](https://www.kavitareader.com/), and many 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 🌮 -* Select best quality volumes when duplicates exist 🌶️ -* Optionally rename volumes and pages for consistency 🫔 -* Exclude any irrelevant garbage files present 🥑 -* Output loose images or repack to CBZ archives 🌯 +* Process most compressed formats, including nested archives 🌮 +* Detect best quality volumes in the presence of duplicates 🌶️ +* Rename volumes and pages using templates for consistency 🫔 +* Exclude any irrelevant garbage files present in your 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 [] -label-book string diff --git a/img/mex.png b/img/mex.png index 8fec8f3..30691df 100644 Binary files a/img/mex.png and b/img/mex.png differ