Updated README based on current state of the bot.
This commit is contained in:
@@ -6,7 +6,7 @@ Frugality is a Discord Bot written in Ruby using `discordrb` and PostgreSQL. Its
|
||||
1. Commands are separated into individual files in `src/commands`. This is the only place you'll need to add a new command.
|
||||
2. Automatically loads and registers new command files on startup.
|
||||
3. Uses PostgreSQL to store data (User IDs, coins amount, reason, timestamps).
|
||||
4. Supports Discord's slash commands.
|
||||
4. Supports Discord's slash commands, and embeds for financial reports.
|
||||
|
||||
## Prerequisites
|
||||
Before running the bot, ensure you have the following installed on your system:
|
||||
@@ -14,7 +14,6 @@ Before running the bot, ensure you have the following installed on your system:
|
||||
* **Bundler**
|
||||
* **PostgreSQL**
|
||||
* **Git**
|
||||
* **ImageMagick**
|
||||
|
||||
## Installation
|
||||
1. **Clone the repository:**
|
||||
@@ -62,7 +61,7 @@ The bot requires a PostgreSQL database.
|
||||
BOT_TOKEN=your_discord_bot_token_here
|
||||
TEST_SERVER_ID=your_discord_server_id
|
||||
```
|
||||
*Note: Add a Server ID only if you're planning on updating the bot frequently, and want instant changes.*
|
||||
*Note: Add a Server ID only if you're planning on updating the bot frequently, and want instant changes. Otherwise, remove it from the .env file and every `server_id: ENV['TEST_SERVER_ID']` line from the `register_application_command` on [src/commands]*
|
||||
|
||||
## Usage
|
||||
To start the bot, you must use `bundle exec` to load the local dependencies:
|
||||
|
||||
Reference in New Issue
Block a user