From a6df2f7648748817a547b50f1effbdb92b2a572d Mon Sep 17 00:00:00 2001 From: Pinapelz Date: Sat, 4 Oct 2025 00:45:27 -0700 Subject: update README with notification info --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 498bbf8..61ad4ee 100644 --- a/README.md +++ b/README.md @@ -58,3 +58,12 @@ pnpm run dev # Middleware The middleware dynamically generated OpenGraph and other metadata tags for posts. This is optional. Only deploy if you need this functionality (aka Discord previews) + +# Notifications +**Requires Middleware to be running** + +Foreground and Background + PWA notifications are available using Firebase Cloud Messaging. Replace the credentials in `site/public/firebase-messaging-sw.js` as well as the necessary Firebase environment variables as shown in `site/.env.template` + +Subscription to individual games are tracked in Redis/Vercel KV as an edge funtion. This is necessary to both track which devices are subscribed to what topic. There is also no existing way in FCM to send a notification to every device without having the tokens stored somewhere. + +Notifications are only sent out each run of `generate.py` for uniquely hashed news entries. -- cgit v1.2.3