From e927ca5f3c46b9c5e8b11cacd169944ffc442c9a Mon Sep 17 00:00:00 2001
From: Oskar <oggswald@live.se>
Date: Tue, 1 May 2018 04:05:27 +0200
Subject: [PATCH] Add event documentation to the README

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

diff --git a/README.md b/README.md
index 5be6bcf..9b53774 100644
--- a/README.md
+++ b/README.md
@@ -9,3 +9,50 @@ Simple and highly configurable staffchat
 
 ## Download
 You can download the plugin from the [Spigot resource page](https://www.spigotmc.org/resources/37804/) or via the [GitHub releases](https://github.com/oskar3123/StaffChat/releases)
+
+## Event API (For developers)
+For Bukkit/Spigot servers:
+```java
+public class StaffChatListener implements Listener
+{
+
+    @EventHandler
+    public void onStaffChat(StaffChatEvent event)
+    {
+        // String format = event.getFormat();
+        // event.setFormat("&b{NAME} >> {MESSAGE}");
+        // String message = event.getMessage();
+        // Player player = event.getPlayer();
+        // event.setCancelled(true);
+    }
+
+}
+```
+Register the listener with
+```java
+getServer().getPluginManager().registerEvents(new StaffChatListener(), this);
+```
+in your plugin onEnable.
+
+For BungeeCord servers:
+```java
+public class StaffChatListener implements Listener
+{
+
+    @EventHandler
+    public void onStaffChat(BungeeStaffChatEvent event)
+    {
+        // String format = event.getFormat();
+        // event.setFormat("&b{NAME} >> {MESSAGE}");
+        // String message = event.getMessage();
+        // Player player = event.getPlayer();
+        // event.setCancelled(true);
+    }
+
+}
+```
+Register the listener with
+```java
+getProxy().getPluginManager().registerListener(this, new StaffChatListener());
+```
+in your plugin onEnable.