Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
dy-tea committed Mar 28, 2024
1 parent bcc3178 commit 4ff62f6
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 4ff62f6

Please sign in to comment.