shift-bot/README.md
Pierre de Lacroix f83fded289
initial commit
2026-06-27 17:33:03 +02:00

29 lines
721 B
Markdown

# Shift bot
A bot for handling shifts.
## Build
Build with
```bash
> cargo build --release
[...]
# executable is here
> ls target/release/shift_bot
target/release/shift_bot
```
## Usage
Make sure `shift_bot` is in your path for what follows. Alternatively, you can replace command
`shift_bot` with `cargo run --release --` in the instructions below, assuming you are at the root
of this repository.
```bash
shift_bot --username shift_bot --homeserver interhacker.space --password SO_SECRET --grist_api_key SECRET_TOO
# alternatively
shift_bot -u neko -s interhacker.space -p SO_SECRET --grist_api_key SECRET_TOO
# or, if the homeserver is `matrix.org`
shift_bot -u neko -p SO_SECRET --GRIST_API_KEY SECRET_TOO
```