From 4ff62f6d343c16137ef0ff4f6e6f7debd7909d06 Mon Sep 17 00:00:00 2001
From: Dylan Donnell <dylan.donnell@student.griffith.ie>
Date: Thu, 28 Mar 2024 12:50:35 +0000
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bad6681
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# rr-dl
+
+_Royal Road Novel Downloader_
+
+## Usage
+
+```
+Usage: rr-dl [options] [ARGS]
+
+Description: A cli program for downloading novels from royalroad.com
+
+Options:
+  -a, --all                 Select all chapters
+  -t, --title               Add chapter title to start of file
+  -I, --indexing <int>      Index chapters starting from value
+  -i, --index               Prefix title with chapter index
+  -d, --directory <string>  Set download location
+  -h, --help                display this help and exit
+  --version                 output version information and exit
+```
+
+## Examples
+Search for novel
+```
+rr-dl
+```
+
+Search for novels titled "test"
+```
+rr-dl test
+```
+
+Search for novels titled "test" and select all chapters for download
+```
+rr-dl -a test
+```
+
+Search for novels titled "test" and prefix chapter titles with index + 10
+```
+rr-dl -I 10 test
+```