aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorPinapelz <yukais@pinapelz.com>2026-06-06 02:48:04 -0700
committerPinapelz <yukais@pinapelz.com>2026-06-06 02:48:04 -0700
commitd3bd7f522ef750d809e9cdb6067a34dc3d1a9273 (patch)
treeaeb0a4d9c5243d9bbdbfccbbaef48202ae1bc1a9 /README.md
parent50f2d99d15dadf925271d17cefba0d1fb9d36cfe (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 996046e..61b3c6c 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,27 @@
# k-heardle
+k-heardle is a Wordle-like game where you guess a song based on a given clip.
+# Daily Mode
+- Available once a day and resets every day at midnight UTC time.
+- A random segment of audio from a song is generated
+
+The state of the daily game is kept locally and a signature is generated to prevent this from being blatantly modified. All guesses are verified server-side
+
+> This is for fun and therfore inherently insecure, it is trivial to forge the signature and change the state of a running game
+
+# Unlimited Mode
+- Unlimited play
+- Uses a minimized YouTube miniplayer for audio
+- Song segments always start at the beginning of the video
+- Guesses are verified locally
+
+> Its recommended to play in fullscrene to prevent any media modules from leaking the solutions
+
+
+# Local Development
```bash
pnpm i
pnpm dev
```
+
+This repo is a fork of [EpicWolverine/PersonalHeardle](https://github.com/EpicWolverine/PersonalHeardle), however much of the code has been modified to a client-server relationship and the CRA has been deprecated in favor of Vite.
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage