aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorPinapelz <yukais@pinapelz.com>2026-08-03 17:48:05 -0700
committerPinapelz <yukais@pinapelz.com>2026-08-03 17:48:05 -0700
commit7467b1a29e3482a93a2c64c186fe6898438d50dd (patch)
tree98fd99d09fa8556519b1ba9cb55b47e63f863490 /README.md
parentb37a7ffc5b19f7330050970ebac7f949a89812a2 (diff)
add prelim docs for group streaks featHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index e1382d1..194f708 100644
--- a/README.md
+++ b/README.md
@@ -23,6 +23,12 @@ The state of the daily game is kept locally and a signature is generated to prev
- Needs to be explictly enabled (set `ENABLE_DAILY_MUSIC_VIDEO` environment variable to `true`)
- This is relayed in the `/info` endpoint, daily generation script checks this to see if it should generate content for this game mode
+# Groups
+- Groups allow users to band together and track how many consecutive days they can guess the correct answer
+- Users can create/join a group on the home page, each user may only join 1 group
+- The streak counter only increments/stays alive if someone guesses the answer correctly
+- Internally, this is tracked in a SQLite DB
+
# Local Development
```bash
pnpm i
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage