]> git.frustrated-labs.net Git - squad-rotation-bot.git/commitdiff
docs: update readme with squad member management instructions
authorAlexander Goussas <[email protected]>
Sat, 1 Nov 2025 00:02:30 +0000 (19:02 -0500)
committerAlexander Goussas <[email protected]>
Sun, 2 Nov 2025 00:42:31 +0000 (19:42 -0500)
README.md

index dadca3ce21c064064188d268052a1aeb450a2910..6beaef25b1ff044760c16dd04878993914a4c179 100644 (file)
--- a/README.md
+++ b/README.md
@@ -33,6 +33,40 @@ export WEB_HOOK_URL='...'
 docker compose up -d
 ```
 
+## Managing squad members
+
+You basically have 3 options for managing squad members.
+
+### 1. Edit the `databse/init.sql` file
+
+You can edit the database initialization script and add `INSERT` statements to
+insert your squad members.
+
+### 2. Exec into the Postgres container
+
+You can also exec into the running Postgres container to use `psql` to `INSERT` the
+squad members:
+
+```shell
+docker compose exec db psql -U postgres
+```
+
+That command will start a `psql` console where you can issue your database commands.
+
+Make sure to replace `postgres` by whatever value you've configured as the
+database user, if any. `postgres` is the default one.
+
+### 3. Use the provided CLI
+
+There is a Docker image that packages a CLI tool to manage your squad members.
+You can run it with the following command:
+
+```shell
+docker run -it --network host aloussase69/squad-rotation-bot-cli
+```
+
+TODO: demo
+
 ## Contributing
 
 Contributing ideas: