From a4b7e7245268ef776d47e399874b4a06d8e9fcb6 Mon Sep 17 00:00:00 2001 From: ChrisChrome Date: Mon, 23 Dec 2024 08:17:21 -0700 Subject: [PATCH] Update README.md with install instructions for roblox module --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index ee2546a..ff18b67 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,13 @@ This project aims to solve a simple but crucial problem: managing bans across ro 3. Configure the `.env` file with your database and API settings (see `.env.example`) 4. Run `node .` to start the server --> +## Usage on Roblox +1. Download the [UBS Main Module here](https://ubs.rtech.foundation/UnifiedBanSystem.rbxm) +2. Insert the module into your game +3. Move the module to `ServerScriptService` +4. Configure via the `Configuration` module, or just leave it as-is to use the default settings +5. Profit! + ## API Documentation ### 🔓 Unauthenticated Endpoints `GET /health` - Healthcheck endpoint (For Uptime Kuma)