diff --git a/README.md b/README.md index b9755b9..9cbe244 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,21 @@ # prose_dl 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 Will download all your posts from [`prose.sh`](https://prose.sh/) into a folder named after your username: ```bash -$ ./prose_dl +$ prose_dl ``` More info with the `--help` option.