Delete README.md

This commit is contained in:
Mahad Kalam 2024-09-04 10:30:41 +01:00 committed by GitHub
parent 55cc50f721
commit b97c26799f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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<String, i32>`, 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._