From 0b90de1a6a093050a3cd3652e26c64c36b629b7a Mon Sep 17 00:00:00 2001 From: Alexander Goussas Date: Fri, 31 Oct 2025 19:02:30 -0500 Subject: [PATCH] docs: update readme with squad member management instructions --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index dadca3c..6beaef2 100644 --- 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: -- 2.43.0