From 397a8a459a11b85ac12649c765866ca8eaec16d1 Mon Sep 17 00:00:00 2001
From: FernandoJVideira <03.pleaser-minster@icloud.com>
Date: Wed, 18 Mar 2026 05:15:12 +0000
Subject: [PATCH] chore: readme & help update

---
 README.md                      | 16 ++++++++++++++++
 internal/commands/help/help.go | 16 ++++++++++++++++
 2 files changed, 32 insertions(+)

diff --git a/README.md b/README.md
index 2a01daf..74832fc 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,8 @@ It currently includes:
 - Scheduling (1:1 sessions with DM invites + reaction-based accept/decline/reschedule)
 - Projects (list/create projects + helpers)
 - Music (Lavalink-powered `/play`, `/queue`, `/volume`)
+ - Twitch live notifications (per-guild `/config` setup)
+ - Welcome messages, DMs, and default role assignment (per-guild `/config` setup)
 
 ## Requirements
 
@@ -34,6 +36,10 @@ Optional (music):
 - `LAVALINK_HOST`: Lavalink WebSocket/HTTP host (depends on your Lavalink setup)
 - `LAVALINK_PASSWORD`: Lavalink password
 
+Optional (Twitch live notifications):
+
+- `TWITCH_CLIENT_ID`: Twitch Client ID used to query live status
+
 ## Database setup
 
 If you use the compose file:
@@ -90,6 +96,16 @@ just down    # stop postgres
   - `/projects list`, `/projects create`, `/projects add-helper`
 - **Music** (requires **DJ** role)
   - `/play`, `/queue`, `/volume`
+- **Twitch live notifications** (**Manage Server**)
+  - `/config addstreamer username:<twitch-name>` — Add a streamer for notifications
+  - `/config removestreamer username:<twitch-name>` — Remove a streamer
+  - `/config settwitchnotificationchannel channel:#channel` — Channel for live pings
+- **Welcome / onboarding** (**Manage Server**)
+  - `/config setwelcomechannel channel:#channel` — Channel for welcome messages
+  - `/config setwelcomemessage message:"..."` — Server welcome template (supports `{user}`, `{server}`)
+  - `/config setwelcomedm message:"..."` — DM welcome template (supports `{user}`, `{server}`)
+  - `/config setwelcomegif url:<image-url>` — GIF/image used in welcome embed
+  - `/config setdefaultrole role:@role` — Role automatically granted on join
 
 ## Notes
 
diff --git a/internal/commands/help/help.go b/internal/commands/help/help.go
index b090c68..a630d10 100644
--- a/internal/commands/help/help.go
+++ b/internal/commands/help/help.go
@@ -106,6 +106,22 @@ func HelpHandler(s *discordgo.Session, i *discordgo.InteractionCreate) {
 					"`/leaderboard` — Top levels (server only)\n" +
 					"`/rewards` — List configured rewards (server only)",
 			},
+			{
+				Name: "Twitch live notifications (**Manage Server**)",
+				Value: "" +
+					"`/config addstreamer username:<twitch-name>` — Add a streamer\n" +
+					"`/config removestreamer username:<twitch-name>` — Remove a streamer\n" +
+					"`/config settwitchnotificationchannel channel:#channel` — Set notification channel",
+			},
+			{
+				Name: "Welcome / onboarding (**Manage Server**)",
+				Value: "" +
+					"`/config setwelcomechannel channel:#channel` — Channel for welcome messages\n" +
+					"`/config setwelcomemessage message:\"...\"` — Welcome text (supports `{user}`, `{server}`)\n" +
+					"`/config setwelcomedm message:\"...\"` — DM template (supports `{user}`, `{server}`)\n" +
+					"`/config setwelcomegif url:<image-url>` — GIF/image used in welcome embed\n" +
+					"`/config setdefaultrole role:@role` — Role granted to new members",
+			},
 			{
 				Name:  "Other",
 				Value: "`/help` — Show this help in DMs",