Update README.md

README.md

@@ -1,3 +1,34 @@
 # GriefAlert
 
-A simple grief alert plugin using CoreProtect API.
+GriefAlert a simple plugin that alerts the staff when someone is griefing on the server.
+
+**CoreProtect is required for this plugin to work.** DiscordSRV is recommended.
+
+## Features
+
+* Alerts the staff when players break blocks, steal items or kill mobs in other players' builds.
+* Alerts go to the chat of ingame staff and optionally Discord.
+* Players and coordinates can be excluded from alerts.
+
+## Permissions
+
+* `griefalert.notify` - Gives an ability to view alerts in the chat.
+* `griefalert.exclude` - Completely excludes a player from triggering alerts.
+* `griefalert.exclude.<player>` - Excludes a player from triggering alerts when touching the specified player's stuff.
+* `griefalert.staff` - Ability to use staff commands.
+
+## Commands
+
+* `/griefalert ignore [world] <x> <y> <z>` - Ignores a location from alerts.
+* `/griefalert unignore [world] <x> <y> <z>`
+* `/griefalert check [world] <x> <y> <z>` - Tells if a location is ignored.
+
+## Discord support
+
+If you have DiscordSRV installed, you can add this to it's alerts.yml:
+```yaml
+- Trigger: net.ardakaz.griefalert.GriefAlertEvent
+    Channel: grief-alerts
+    Content: "${getAlert()}"
+```
+You'll also have to specify the grief-alerts channel in config.yml.