From 8b45669caed85d98da2c4a8418e0545506ab6c5e Mon Sep 17 00:00:00 2001
From: simon987 <me@simon987.net>
Date: Sat, 22 Feb 2020 12:45:01 -0500
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3545cfb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# cbr2cbz
+
+Convert a .cbr file to a .cbz file without modifying the original document.
+
+## Usage
+
+```bash
+cbr2cbz file1.cbr file2.cbr ...
+```
+
+**Convert all files in a directory**
+```bash
+cbr2cbz /path/to/comics/*.cbr
+cbr2cbz /path/to/comics/**/*.cbr
+```
+
+**Convert all files in a directory (multithreaded)**
+```bash
+find /path/to/comics/ -name '*.cbr' | parallel -j4 cbr2cbz {}
+```
+
+## Build from source
+```bash
+cmake .
+make
+```