diff --git a/README.md b/README.md index a5bf114..6975308 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,14 @@
A multipurpose Discord bot written in Java. -## Tested Environments -- Java 21+ (May work on older versions but untested) +## Required Environment +- Java 17+ (May work on older versions but untested) - Maven ### Tested Operating Systems -- macOS 14.4.1 -- Windows 10 (22H2) +- macOS 14 & 15 (arm64) +- Windows 10 22H2 (x86_64) +- Debian 12 (x86_64) --- @@ -28,9 +29,11 @@ A multipurpose Discord bot written in Java. ## Commands -| Command | Description | Arguments | Aliases | -|---------|------------------------------------------------------------------------------|-------------------------------------|---------| -| `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 | -| `mute` | Mutes a member for a specified amount of time | `[user ping]`, `[timeout duration]` | None | \ No newline at end of file +| Command | Description | Arguments | +|-------------------|------------------------------------------------------------------------------|-----------------------------------------------------------| +| `/ping` | Gets the bot's gateway & rest ping | None | +| `/whois` | Gets information about the specified user (message author if none specified) | `[member]` | +| `/timeout set` | Times out a member for a specified amount of time | `[member]`, `[duration]`, `(reason)` | +| `/timeout get` | Gets the current timeout status of the specified member | `[member]` | +| `/timeout cancel` | Cancels the specified users timeout | `[member]`, `(reason)` | +| `/poll` | Creates a poll | `[title]`, `[duration]`, `[options]`, `(multiple-choice)` |