summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Panić <david@panic.tk>2019-04-07 20:15:33 +0200
committerDavid Panić <david@panic.tk>2019-04-07 20:15:33 +0200
commitdf36c6d3d431179f4be5f081424c506b4d415029 (patch)
treea6ca5f639b3532b9a6a270752ccf476414bc0e90
parent9b9b278bef80e19a1db41f2cc25fced07314df4d (diff)
Added permissions and commands to readme
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9c0a648..224dc67 100644
--- a/README.md
+++ b/README.md
@@ -4,4 +4,14 @@ A BungeeCord plugin that allows banning players.
## Building
-To build the plugin jar file use `./gradlew shadowJar` on Linux or `gradlew.bat shadowJar` on Windows. \ No newline at end of file
+To build the plugin jar file use `./gradlew shadowJar` on Linux or `gradlew.bat shadowJar` on Windows.
+
+## Permissions & commands
+
+These permissions should be added in the BungeeCord config.yml file and **NOT** on any of the Bukkit/Spigot/whatever servers.
+
+| Permission | Command | Usage |
+|-------------------|---------------------------------------------|----------------------------------------------------|
+| bungeebans.ban | /ban \<username\> [reason] | Bans the specified player with an optional reason. |
+| bungeebans.unban | /unban \<username\> or /pardon \<username\> | Unbans the specified player. |
+| bungeebans.getban | /getban \<username\> | Displays a player's ban status. | \ No newline at end of file