Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dy-tea committed Dec 25, 2024
1 parent 669746b commit 11320c7
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,31 +23,31 @@ Options:
```

## About
This is a downloader focused on downloading novels in the Markdown format. This makes it simple to read in apps like [Obsidian](https://obsidian.md). This allows for the original formatting of the text to be preserved because it is essentially just a renamed `html` file. The default file extension is `md` but can be changed to `html` if you want to use a browser to display the chapters (although not recommended).
This is a downloader focused on downloading novels in the **Markdown** format. This makes it simple to read in apps like [Obsidian](https://obsidian.md). This allows for the original formatting of the text to be preserved because it is essentially just a renamed `html` file. The default file extension is `md` but can be changed to `html` if you want to use a browser to display the chapters (although it is not recommended).

## Examples
Search for novel
```
rr-dl
```

Search for novels titled "test"
Search for novels titled `test`
```
rr-dl test
```

Search for novels titled "test" and select all chapters for download
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
Search for novels titled `test` and prefix chapter titles with index + 10
```
rr-dl -I 10 test
```

## Building
First install [V](https://vlang.io), then run the following commands (ensure you have added v to PATH using `v symlink`):
First install [the V programming language](https://vlang.io), then run the following commands (ensure you have added v to PATH using `v symlink`):

```
git clone https://github.com/dy-tea/rr-dl.git
Expand Down

0 comments on commit 11320c7

Please sign in to comment.