add installation section

This commit is contained in:
Mylloon 2022-08-20 20:31:00 +02:00
parent 1e79de3a55
commit a110c8b552
Signed by: Anri
GPG key ID: A82D63DFF8D1317F

View file

@ -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.