From 304943799a31fba04485089efac15eaa221600fc Mon Sep 17 00:00:00 2001
From: Daniel Ratcliffe <dratcliffe@gmail.com>
Date: Fri, 17 Dec 2021 02:35:01 +0000
Subject: [PATCH] Create README.md

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3ae01de
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# CBZTool
+
+CBZ tool is an easy command line tool for creating and manipulating Comic Books stored in the .cbz format.
+
+It can extract pages from books, create new books from pages, combine multiple books into one.
+
+## Example usage
+
+Extract all the pages from a book:
+```
+CBZTool extract MyComic.cbz
+```
+
+Create a new book from a folder of images:
+```
+CBZTool compress MyFolder
+```
+
+Combine the first 6 pages of 2 different books:
+```
+CBZTool extract MyFirstComic.cbz -o Temp -p 1-6
+CBZTool extract MySecondComic.cbz -o Temp -p 1-6 -a
+CBZTool compress Temp -o MyCombinedComic.cbz
+```
+
+Create a copy of a book with improved image quality:
+```
+CBZTool extract MyComic.cbz -o MyEnhancedComic -denoise -whitebalance
+CBZTool compress MyEnhancedComic
+```
+
+## All options
+
+```
+CBZTool extract PATH... [options]
+  -o [directory]    Specify the directory to extract to (defaults to the input path minus the extension)
+  -p [range]        Specify the range of pages to extract (ex: 1-10 2,4,6 7-*) (default=*)
+  -a                Appends the extracted pages to the end of the directory, instead of replacing them (default=0)
+  -denoise          Runs a noise reduction algorithm on the images when extracting (default=0)
+  -whitebalance     Runs a white balancing algorithm on the images when extracting (default=0)
+  -metadata         Specify that metadata files (tag.txt, ComicInfo.xml) should also be extracted (default=0)
+
+CBZTool compress PATH... [options]
+  -o [directory]    Specify the file to compress to (defaults to the input path with the .cbz extension appended)
+  -p [range]        Specify the range of pages to compress (ex: 1-10 2,4,6 7-*) (default=*)
+  -a                Appends the extracted pages to the end of the archive, instead of replacing it (default=0)
+  -metadata         Specify that metadata files (tag.txt, ComicInfo.xml) should also be added (default=0)
+```