From 44f15de3679089e9bd200372e7208dfc5801ccf6 Mon Sep 17 00:00:00 2001 From: nanos Date: Tue, 28 Mar 2023 09:38:48 +0100 Subject: [PATCH] readme updates --- README.md | 4 +++- examples/FediFetcher.sh | 4 ++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3c9e214..66f510c 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,9 @@ If you want to, you can of course also run FediFetcher locally as a cron job: 1. To get started, clone this repository. 2. Install requirements: `pip install -r requirements.txt` -3. Then simply run this script like so: `python find_posts.py --access-token= --server=` etc. An example script can be found in the [`examples`](https://github.com/nanos/FediFetcher/tree/main/examples) folder (Read below, or run `python find_posts.py -h` to get a list of all options) +3. Then simply run this script like so: `python find_posts.py --access-token= --server=` etc. (Read below, or run `python find_posts.py -h` to get a list of all options.) + +An example script can be found in the [`examples`](https://github.com/nanos/FediFetcher/tree/main/examples) folder. When using a cronjob, we are using file based locking to avoid multiple overlapping executions of the script. The timeout period for the lock can be configured using `--lock-hours`. diff --git a/examples/FediFetcher.sh b/examples/FediFetcher.sh index 5ef20eb..253f15f 100644 --- a/examples/FediFetcher.sh +++ b/examples/FediFetcher.sh @@ -2,6 +2,10 @@ # to run every 10 minutes from your cron job. # Supply any other arguments, as you see fit. + +# Sample schedule: +# */10 * * * * /usr/bin/bash /path/to/FediFetcher.sh + ###################### IMPORTANT ###################### # # # YOU SHOULD RUN THIS SCRIPT MANUALLY AT LEAST ONCE #