diff --git a/README.md b/README.md index 3982c98..26518e9 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,34 @@ # prose_dl + Helper to download all posts from prose.sh instance -[![dependency status](https://deps.rs/repo/gitea/git.kennel.ml/Anri/prose_dl/status.svg)](https://deps.rs/repo/gitea/git.kennel.ml/Anri/prose_dl) +[![dependency status](https://deps.rs/repo/gitea/git.mylloon.fr/Anri/prose_dl/status.svg)](https://deps.rs/repo/gitea/git.mylloon.fr/Anri/prose_dl) ## Installation + Clone the repo and get in + ```bash -git clone https://git.kennel.ml/Anri/prose_dl.git && cd prose_dl +git clone https://git.mylloon.fr/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 ``` Will download the special files too: + ```bash $ prose_dl -s ``` @@ -28,11 +36,15 @@ $ prose_dl -s More info with the `--help` option. ## FAQ -> Can this download unlisted posts (thoses with *date metadata* set in the future)? + +> Can this download unlisted posts (thoses with _date metadata_ set in the future)? + - No. > Can this download specials files? + - Yes, with `-s` option > Can I use a custom domain? + - Yes, with `--domain` option