Raine-gay/royal_road_archiver
1
0
Fork 0
mirror of https://github.com/Raine-gay/royal_road_archiver.git synced 2024-11-23 07:38:42 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Raine-gay 2024-01-26 22:41:43 +00:00 committed by GitHub
parent 88c78423c4
commit f6f268330c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -21,6 +21,10 @@
``cd`` to the folder containing the binaries,
Run it using ``royal_road_archiver``
* Cargo - Run ``cargo install royal_road_archiver``,
Then just run ``royal_road_archiver`` from the terminal.
**DOES NOT WORK ON WINDOWS**
### Example commands:
* ``royal_road_archiver https://www.royalroad.com/fiction/59450/bioshifter epub`` --- Will create an Epub version of the novel bioshifter in the current directory.
* ``royal_road_archiver https://www.royalroad.com/fiction/59450/bioshifter markdown --no-image-tags`` --- Will create a markdown version of the novel bioshifter in the current directory, removing image tags from the markdown file.