From 47c7d02262255c1bddc4fa21139d4b99eb0383cc Mon Sep 17 00:00:00 2001
From: 7orivorian <7orivorian+github@gmail.com>
Date: Tue, 4 Jun 2024 00:40:31 -0400
Subject: [PATCH] Update README.md
Signed-off-by: 7orivorian <7orivorian+github@gmail.com>
---
README.md | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/README.md b/README.md
index b9a735d..4cc101e 100644
--- a/README.md
+++ b/README.md
@@ -71,6 +71,8 @@ Packaged file can be found in the `target/` directory.
While the code itself is thoroughly documented, here's a simple guide to help you get started with the latest features.
### Subscribers
+
+Details...
To define a subscriber, you have multiple options:
@@ -113,8 +115,11 @@ public class Example {
}
}
```
+
### Defining Events
+
+Details...
Any class can be used as an event. For instance:
@@ -153,8 +158,11 @@ public class CancelableEvent implements ICancelable {
// ...
}
```
+
### Listeners
+
+Details...
For class event listeners, you can define your listeners as follows:
@@ -201,8 +209,11 @@ public class ExampleSubscriber extends Subscriber {
}
}
```
+
### Dispatching Events
+
+Details...
To dispatch an event to an event bus, simply call one of the `dispatch` methods defined in any `IEventBus`
implementation, passing your event as a parameter:
@@ -226,6 +237,7 @@ public class Example {
}
}
```
+
Feel free to explore the [example folder](examples/java/me/tori/example) for more Wraith implementations.