aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLinnea Gräf <nea@nea.moe>2025-05-12 21:38:16 +0200
committerLinnea Gräf <nea@nea.moe>2025-05-12 21:38:16 +0200
commited04cb142afa5a2ecdfb1472936e237d49f58e73 (patch)
tree7f38b3f82c9e669f1b5319458facf9736c6178b0 /README.md
parentf095da2b9cb6f74372ae6e4268d162a1a4c9a033 (diff)
downloadboobbot-nightly.tar.gz
boobbot-nightly.tar.bz2
boobbot-nightly.zip
add installation instructionsHEADnightlymaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 25 insertions, 1 deletions
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
+```