From: Alexander Goussas <alexandergoussas.thoughtworks@latam.com>
Date: Fri, 31 Oct 2025 03:13:54 +0000 (-0500)
Subject: docs: add README
X-Git-Url: http://git.frustrated-labs.net/?a=commitdiff_plain;h=b949dd41cf4f5c1adec8466a51d70ae0bcfb89d1;p=squad-rotation-bot.git

docs: add README
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dadca3c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# Squad Rotation Bot
+
+This is a bot that you can integrate into your gchat spaces to send a message
+to indicate who's turn is it to facilitate the daily.
+
+## Configuring
+
+Make sure to configure the following according to your needs:
+
+- **The time at which to run the bot** is configured in `scripts/crontab`.
+  Follow the indications in that file.
+- **Set the webhook URL** by setting the `WEB_HOOK_URL` environment variable to
+  the value of the gchat webhook URL. You can generate this in the integrations
+  settings tab of your gchat space.
+- **Optionally configure the database connection details** by setting the
+  environment variables used in the compose file
+
+## Usage
+
+### With docker-compose
+
+1. Clone this repository:
+
+```shell
+git clone https://github.com/aloussase/squad-rotation-bot
+cd squad-rotation-bot
+```
+
+2. Run the services:
+
+```shell
+export WEB_HOOK_URL='...'
+docker compose up -d
+```
+
+## Contributing
+
+Contributing ideas:
+
+- More messaging backends (e.g.: discord, slack, carrier pigeon; etc)
+
+## License
+MIT