diff --git a/README.md b/README.md index b2ec96f..0d89eee 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # cbr2cbz -BASH tool to convert cbr files to cbz files either in batch or one by one. \ No newline at end of file +BASH tool to convert cbr files to cbz files either in batch or one by one. + +Download the tool using: + +$ git clone git@git.zaks.web.za:thisiszeev/cbr2cbz.git + +$ chmod +x cbr2cbz.sh + +$ sudo cp cbr2cbz.sh /usr/bin/cbr2cbz + +That's it. + +Usage: cbr2cbz single "filename.cbr" + Convert a single file. +Usage: cbr2cbz all + Convert all files recursively from the current location. +Usage: cbr2cbz help + Display this text. + +Warning: If conversion is successful, the original file(s) will be deleted.