improve README docs

2 files changed, 43 insertions, 0 deletions

diff --git a/README.md b/README.md
index 559d393..8e3c9ce 100644
--- a/README.md
+++ b/README.md
@@ -27,3 +27,30 @@ 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.
 
 The CSS theme of the site is based on dacctal's [caelus](https://git.symlinx.net/daccfiles/)
+
+# Deployment
+The `playlist_generator` directory contains scripts relevant to generating `songs.ts` which contains all songs used in K-Heardle.
+
+First enter the directory and install the dependencies
+```bash
+uv sync
+uv init
+```
+
+## `playlist_generator.py`
+Generates/updates a songs.ts file given a file of YouTube links
+```bash
+uv run playlist_generator.py <INPUT_FILE> <OUTPUT_FILE> 
+```
+- INPUT_FILE is a text file of YouTube URLs to songs
+- OUTPUT_FILE the `songs.ts` file to output to, defaults to `../server/data/songs.ts`
+
+## `generate_daily.py`
+Generates a daily song snippet for daily game mode. Intended to be run once a day
+
+> Requires a environment variables to be configured see `playlist_generator/.env.template`
+
+ ```bash
+ uv run generate_daily.py
+ ```
+By default this script assumes Cloudflare R2, however any S3 bucket credentials will work fine
diff --git a/playlist_generator/.env.template b/playlist_generator/.env.template
index e69de29..438f159 100644
--- a/playlist_generator/.env.template
+++ b/playlist_generator/.env.template
@@ -0,0 +1,16 @@
+# Cloudflare R2 credentials
+R2_ACCOUNT_ID=
+R2_ACCESS_KEY=
+R2_SECRET_KEY=
+R2_BUCKET=
+
+# API endpoint (must expose /today returning { date, data })
+API_URL=
+
+# Heardle obfuscation key (use one of these)
+VITE_HEARDLE_SALT=
+# OBFUSCATION_KEY=
+
+# Ntfy notifications (optional but required for alerts)
+NTFY_URL=
+NTFY_TOKEN=