-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |