From ed04cb142afa5a2ecdfb1472936e237d49f58e73 Mon Sep 17 00:00:00 2001 From: Linnea Gräf Date: Mon, 12 May 2025 21:38:16 +0200 Subject: add installation instructions --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 857733c..d734aed 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,28 @@ > backronym ordaining & originating bot -comes up with a new backronym once a day \ No newline at end of file +comes up with a new backronym once a day + +## How to install / update + + +```bash +cd ~; mkdir -p boobbot; (cd boobbot; curl -L https://github.com/nea89o/boobbot/releases/download/nightly/dist.zip > dist.zip; unzip -o dist.zip; sudo ./install.sh) +``` + +Instead of `cd ~` you can use wherever else you would like the boobbot directory to lie. Installs a systemd service and timer that you can enable or invoke directly using + +```bash +# To post a boob joke daily +systemctl enable boobjob.timer + +# To post a boob joke once +systemctl start boobbot.service +``` + +Add a .env file to `boobbot/rt/.env` containing your misskey instance and id: + +```env +MISSKEY_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXX +MISSKEY_INSTANCE=https://sk.amy.rip +``` -- cgit