Updated README.
This commit is contained in:
@@ -5,7 +5,7 @@ Frugality is a Discord Bot written in Ruby using `discordrb` and PostgreSQL. Its
|
||||
## Features
|
||||
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 user data.
|
||||
3. Uses PostgreSQL to store data (User IDs, coins amount, reason, timestamps).
|
||||
4. Supports Discord's slash commands.
|
||||
|
||||
## Prerequisites
|
||||
@@ -46,8 +46,7 @@ The bot requires a PostgreSQL database.
|
||||
createdb database
|
||||
```
|
||||
**The database name is also specified [here](https://git.thenight.club/csxkdv/FrugalityBot/src/branch/main/src/database.rb). Ensure it's the same as the one you'll use.**
|
||||
|
||||
*Note: The bot will automatically create the necessary tables (like `total_money`) the first time it connects. If you want new tables, update the database file as desired.*
|
||||
*Note: The bot will automatically create the necessary tables (like `wallets` and `transactions`) the first time it connects. If you want new tables, update the database file as desired.*
|
||||
|
||||
## Configuration
|
||||
|
||||
@@ -59,13 +58,17 @@ The bot requires a PostgreSQL database.
|
||||
2. Add your secrets to the `.env` file:
|
||||
```env
|
||||
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.*
|
||||
|
||||
## Usage
|
||||
To start the bot, you must use `bundle exec` to load the local dependencies:
|
||||
```bash
|
||||
bundle exec ruby main.rb
|
||||
```
|
||||
Wait for the bot to connect, and that's it, you can start using it.
|
||||
|
||||
|
||||
## License
|
||||
This project is licensed under the [GNU General Public License v3.0](COPYING).
|
||||
Reference in New Issue
Block a user