From: Alexander Goussas Date: Tue, 24 Feb 2026 16:12:37 +0000 (-0500) Subject: docs: update readme X-Git-Url: http://git.frustrated-labs.net/?a=commitdiff_plain;h=6cdee70bfb653cadd2fec0559632c5960fc4f3f6;p=squad-rotation-bot.git docs: update readme --- diff --git a/README.md b/README.md index 06605a1..4563f40 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,6 @@ 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. -## Pre-requisites - -This is an application that runs periodically on a scheduled time, so you will -need to have some server where to run it. - -I personally run my instance on one of my Raspberries, but any hosted server -should work as well. I can recommend [Hetzner](https://www.hetzner.com/). - ## Configuring Make sure to configure the following according to your needs: @@ -30,7 +22,7 @@ Make sure to configure the following according to your needs: 1. Clone this repository: ```shell -git clone https://github.com/aloussase/squad-rotation-bot +git clone https://gitlab.com/latamairlines/lyca/eloyalty/loyalty-program-management/mktplace/mkpl/squad-rotation-bot cd squad-rotation-bot ``` @@ -45,10 +37,11 @@ docker compose up -d You basically have 3 options for managing squad members. -### 1. Edit the `databse/init.sql` file +### 1. Edit the `databse/seed.sql` file + +You can edit the database seeding script to add or remove squad members. -You can edit the database initialization script and add `INSERT` statements to -insert your squad members. +You will need to restart the database server from scratch after doing this. ### 2. Exec into the Postgres container @@ -64,22 +57,5 @@ That command will start a `psql` console where you can issue your database comma 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 -``` - -![Squad Rotation Bot CLI Demo](./assets/cli_demo.gif) - -## Contributing - -Contributing ideas: - -- More messaging backends (e.g.: discord, slack, carrier pigeon; etc) - ## License MIT