add installation section
This commit is contained in:
parent
1e79de3a55
commit
a110c8b552
1 changed files with 11 additions and 1 deletions
12
README.md
12
README.md
|
@ -1,11 +1,21 @@
|
||||||
# prose_dl
|
# prose_dl
|
||||||
Helper to download all posts from prose.sh instance
|
Helper to download all posts from prose.sh instance
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
Clone the repo and get in
|
||||||
|
```bash
|
||||||
|
git clone https://git.kennel.ml/Anri/prose_dl.git && cd prose_dl
|
||||||
|
```
|
||||||
|
Then install it
|
||||||
|
```bash
|
||||||
|
cargo install --path .
|
||||||
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
Will download all your posts from [`prose.sh`](https://prose.sh/) into a
|
Will download all your posts from [`prose.sh`](https://prose.sh/) into a
|
||||||
folder named after your username:
|
folder named after your username:
|
||||||
```bash
|
```bash
|
||||||
$ ./prose_dl <username>
|
$ prose_dl <username>
|
||||||
```
|
```
|
||||||
|
|
||||||
More info with the `--help` option.
|
More info with the `--help` option.
|
||||||
|
|
Reference in a new issue