From b97c26799f797c2b7ebdd81e5cbc1907d8e9fafd Mon Sep 17 00:00:00 2001 From: Mahad Kalam <55807755+SkyfallWasTaken@users.noreply.github.com> Date: Wed, 4 Sep 2024 10:30:41 +0100 Subject: [PATCH] Delete README.md --- README.md | 23 ----------------------- 1 file changed, 23 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index 2470e8d..0000000 --- a/README.md +++ /dev/null @@ -1,23 +0,0 @@ -# \#arcade-monitor - -**\#arcade-monitor** is a monitor for the [Hack Club Arcade Shop.](https://hackclub.com/arcade/shop/) It continuously checks for new items, stock changes, and item updates, keeping you in the loop on the stuff you want. - -## Environment variables -### Secrets -- `SLACK_WEBHOOK_URL` - Slack webhook to call on updates -- `NTFY_AUTH_TOKEN` - Auth token for ntfy - -### Variables -- `ARCADE_SHOP_URL` - Shop URL to fetch -- `NTFY_URL` - URL for ntfy -- `SLACK_GROUP_ID` - ID of the Slack group to ping - -## Key-value keys -- `real_prices` - stores the real-world prices of items. equivalent to a `HashMap`, where `String` is the `id` parameter. prices are in USD. -- `items` - stores old items (you don't need to worry about this one) - -## Tech Stack -- **Cloudflare Workers** for running the monitor on the edge. -- **Rust** for the monitor's code. I love its type safety, as well as libraries such as `serde`. - -_Fun fact: the monitor was originally written in TypeScript, but it turned out to be so buggy I just rewrote it in Rust. The new version took less time to write, has tests (unlike the TypeScript version), and has better formatted messages._