From bf5a71621476cc59106b66f167957a493e9a8c70 Mon Sep 17 00:00:00 2001 From: freearhey <7253922+freearhey@users.noreply.github.com> Date: Wed, 19 Jul 2023 22:38:48 +0300 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 8cbe6b40..23e6dd89 100644 --- a/README.md +++ b/README.md @@ -51,12 +51,25 @@ To download a guide in a specific language pass its [ISO 639-1](https://en.wikip npm run grab -- --site=example.com --lang=fr ``` +To also create a compressed version of the guide, add the `--gzip` flag: + +```sh +npm run grab -- --site=example.com --gzip +``` + After the download is completed in the current directory will appear a new folder `guides`, which will store all XML files: ```sh guides └── fr └── example.com.xml + └── example.com.xml.gz +``` + +If you want to download the guide automatically on a schedule, you need to pass a valid [cron expression](https://crontab.guru/) to the script using the `--cron` attribute: + +```sh +npm run grab -- --site=example.com --cron="0 0 * * *" ``` Also you can make these guides available via URL by running your own server: