From 6dd31f7d04b480b71dcc25d3088cbd6621e5090f Mon Sep 17 00:00:00 2001
From: ChrisChrome <chris@chrischro.me>
Date: Mon, 19 Aug 2024 01:31:49 -0600
Subject: [PATCH] Add README.md

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8a81abc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Roblox group funds monitor
+
+This is a simple script that sends and updates a summary of the funds in a Roblox group to a Discord webhook/bot.
+
+## Installation
+
+### Requirements
+- Node.js (v20.0.0 or higher)
+- npm (v8.0.0 or higher)
+- A Discord bot
+- A Roblox group
+- Your ROBLOSECURITY cookie (Look it up)
+
+### Steps
+1. Clone the repository or download the files
+2. Run `npm install` in the directory via a terminal/CMD
+3. Create a `.env` file in the directory with the following content:
+```env
+ROBLOSECURITY=Replace with the cookie data
+DISCORD_TOKEN=Replace with the bot token
+CURRENCY="R$"
+PENDING=":alarm_clock"
+SUMMARY_CHANNEL_ID=Your channel ID
+GROUPID=Your group ID
+```
+4. Run `node .` in the directory via a terminal/CMD.