From 03e029cd4dca8e86635b3cd04f5ef5ee6a3eaec6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Kamil=20=27Kama=C5=9B=27=20Bruchal?=
 <kamil.bruchal.pro@gmail.com>
Date: Wed, 17 Jun 2026 22:29:29 +0200
Subject: [PATCH] docs: updated README.md

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index 3c361a4..4562508 100644
--- a/README.md
+++ b/README.md
@@ -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).
+