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 1/5] 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._ From 405c4973ddbcbbbfbe1812a1c92d0134a5d8e2c9 Mon Sep 17 00:00:00 2001 From: Mahad Kalam <55807755+SkyfallWasTaken@users.noreply.github.com> Date: Wed, 4 Sep 2024 10:30:53 +0100 Subject: [PATCH 2/5] Rename SHOWCASE.md to README.md --- SHOWCASE.md => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename SHOWCASE.md => README.md (100%) diff --git a/SHOWCASE.md b/README.md similarity index 100% rename from SHOWCASE.md rename to README.md From 4b690087f79fb03523928cfd27d0df7f0a3d4641 Mon Sep 17 00:00:00 2001 From: Mahad Kalam <55807755+SkyfallWasTaken@users.noreply.github.com> Date: Wed, 4 Sep 2024 10:33:10 +0100 Subject: [PATCH 3/5] Update README.md --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5459e6d..9a6563d 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,19 @@ # Arcade Monitor: HC's beloved shop ~stalker~ monitor - + -Arcade Monitor is a **monitor for the Hack Club Arcade Shop.** It continuously checks for new items, stock changes, and item updates, keeping you in the loop on the stuff you want. It chatters away in the [#arcade-monitor channel](https://hackclub.slack.com/archives/C079RG9HJ81) to over 350 members across Slack and ntfy. +Arcade Monitor was a **monitor for the Hack Club Arcade Shop.** It continuously checked for new items, stock changes, and item updates, keeping you in the loop on the stuff you want. At its peak, it chattered away in the [#arcade-monitor channel](https://hackclub.slack.com/archives/C079RG9HJ81) to over 400 members across Slack and ntfy. -This has been one of my most successful projects: I managed to get 350 active users of the channel, including many from Hack Club HQ, got third-party contributions to my project for the first time, and managed to get 55 stars, by far my most starred project on GitHub _(will you be the next stargazer? 😉)_ +This has been one of my most successful projects: I managed to get 400 active users of the channel, including many from Hack Club HQ, got third-party contributions to my project for the first time, and managed to nearly 60 stars, by far my most starred project on GitHub _(will you be the next stargazer? 😉)_ If I were to make this project again, I'd probably port it to more platforms, such as Discord webhooks, in order to make it possible for people to use the software they want to use, rather than being forced to use Slack or ntfy :) Arcade Monitor is also fully open source, and licensed under the [MIT License!](https://github.com/SkyfallWasTaken/arcade-monitor/blob/main/LICENSE.md) +The rest of the readme has been archived for posterity. Thank you everyone who checked out Arcade Monitor! + +--- + ## Usage on Slack _(note: you'll need to be a member of the [Hack Club Slack](https://hackclub.com/slack/) for this!)_ From 143d161eb42279a28f67155597beeba2ab80cb9a Mon Sep 17 00:00:00 2001 From: Mahad Kalam <55807755+SkyfallWasTaken@users.noreply.github.com> Date: Wed, 4 Sep 2024 10:33:56 +0100 Subject: [PATCH 4/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9a6563d..53f99e2 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ If I were to make this project again, I'd probably port it to more platforms, su Arcade Monitor is also fully open source, and licensed under the [MIT License!](https://github.com/SkyfallWasTaken/arcade-monitor/blob/main/LICENSE.md) -The rest of the readme has been archived for posterity. Thank you everyone who checked out Arcade Monitor! +The rest of the readme has been archived for posterity. Thank you to everyone who checked out Arcade Monitor! 🫡 --- From c84b70e609843f0020a8cbf8e9162acf5300163f Mon Sep 17 00:00:00 2001 From: Mahad Kalam <55807755+SkyfallWasTaken@users.noreply.github.com> Date: Wed, 4 Sep 2024 10:35:45 +0100 Subject: [PATCH 5/5] Update headings in README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 53f99e2..204a4d7 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,13 @@ The rest of the readme has been archived for posterity. Thank you to everyone wh --- -## Usage on Slack +## Usage +### Usage on Slack _(note: you'll need to be a member of the [Hack Club Slack](https://hackclub.com/slack/) for this!)_ Using the bot with Slack is really easy! Just join the [#arcade-monitor channel](https://hackclub.slack.com/archives/C079RG9HJ81), and you'll be added to the Arcade Monitor user group. You'll now be pinged for every update! -## Usage with ntfy +### Usage with ntfy You'll need [the ntfy app](https://ntfy.sh) for this!