From e7abbd6012504b059b9eac6f7789aef5dbef533a Mon Sep 17 00:00:00 2001 From: floppydiskette Date: Thu, 5 Sep 2024 04:18:36 +0100 Subject: [PATCH] Update README.md --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e6070d2..b0a5baf 100644 --- a/README.md +++ b/README.md @@ -8,4 +8,32 @@ A multipurpose Discord bot written in Java. ### Tested Operating Systems - macOS 14.4.1 -- Windows 10 (22H2) \ No newline at end of file +- Windows 10 (22H2) + +--- + +## Config file schema +```json +{ + "token": "your_token", + "prefix": "oki!", + "mariadb": { + "host": "127.0.0.1", + "user": "db_user", + "password": "db_password", + "database": "doki_prod" + } +} +``` + +--- + +## Commands + +| Command | Description | Arguments | Aliases | +|---------------|------------------------------------------------------------------------------|---------------|---------| +| `leaderboard` | Gets the leaderboard for the current guild | None | `lb` | +| `rank` | Gets the rank of the specified user (message author if none specified) | `[user ping]` | None | +| `about` | Gets information about the bot | None | None | +| `ping` | Gets the bot's gateway & rest ping | None | None | +| `whois` | Gets information about the specified user (message author if none specified) | `[user ping]` | None | \ No newline at end of file