kamash
/
dyzur-bot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: updated README.md

This commit is contained in:
Kamil 'Kamaś' Bruchal 2026-06-17 22:29:29 +02:00
parent a7bbbdc084
commit 03e029cd4d
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -3,3 +3,17 @@
A telegram bot for managing the cleaning rota in hackerspace.
Bot offers weekly reminders about cleaning duties as well as on demand informations.
Backend read the schedule from a Google sheet, store it in local JSON file.
## Running
Requires `GOOGLE_API_KEY` and `GOOGLE_SHEETS_ID` in the environment or a `.env`
file (see `service.go`/`sheet.go` for optional `SHEET_RANGE`, `ROTA_CACHE_PATH`,
`SYNC_INTERVAL`). Then:
```sh
go run ./cmd/dyzur-bot
```
The service loads the cached rota, syncs from Google Sheets in the background on
`SYNC_INTERVAL` (default 30m), and runs until interrupted (Ctrl-C / SIGTERM).