From 2a1f486c2eaeec7e33fcb15fa1633e19d92aae54 Mon Sep 17 00:00:00 2001 From: Kay Faraday Date: Sun, 9 Jan 2022 02:33:04 +0000 Subject: [PATCH] README: add usage instructions --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 30791ea..d69f130 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,21 @@ Clone of https://botsin.space/@PosiBot for freaks. Currently deployed at https://freak.university/@FreakPos. +## Usage + +``` +pip install -r requirements.txt +cp config.example.toml config.toml +``` + +Then, edit config.toml with your access token and instance. +Now edit your crontab (`crontab -e`) and add a line to periodically run freakpos.py. +For example, this posts every four hours with a random delay: + +``` +15 */4 * * * bash -c 'sleep $(( $RANDOM \% (60 * 60 * 4) )) && path/to/FreakPositivity/freakpos.py' +``` + ## License AGPL-3.0-or-later, see LICENSE \ No newline at end of file