@yhwh-script/event-bux 1.0.5 → 1.0.6

package/README.md

@@ -6,17 +6,6 @@ To install the eventbus into your project, simply run
 npm install @yhwh-script/event-bux
 ```
 
-## EventBus architecture
-
-```mermaid
-classDiagram
-    EventTarget <|-- EventBus
-    EventTarget: +addEventListener()
-    EventTarget: +removeEventListener()
-    EventTarget: +dispatchEvent()
-    EventBus: -WeakMap listeners
-```
-
 ## How-To
 
 For instance: 
@@ -30,12 +19,30 @@ For instance:
 
 After importing `@yhwh-script/event-bux`, it is recommended to add it to the `window` object.
 
-You can use your own import or stick to other `@yhwh-script` examples
+Feel free to import at your own or stick to `@yhwh-script` examples.
+
+Then use `bus.addEventListener(type, listener)` and `bus.dispatchEvent(event)` in your WebComponents. You are not bound to event bubbling or capturing, which are the standard event propagation mechanisms, but now you can send events even among any objects!
+
+```javascript
+bus.addEventListener("click", () => {console.log("click")}, window);
+bus.dispatchEvent(new Event("click"), window);
+```
 
-Then use `bus.addEventListener(type, listener)` and `bus.dispatchEvent(type, event)` in your WebComponents. You are not bound to event bubbling or capturing (which are the standard event propagation mechanisms), but you can send events even between WebComponents! Check it out!
+## EventBus architecture
 
 ![EventBus schema](eventbus.png)
 
+```mermaid
+classDiagram
+    EventTarget <|-- EventBus
+    EventTarget: +addEventListener()
+    EventTarget: +removeEventListener()
+    EventTarget: +dispatchEvent()
+    EventBus: -WeakMap listeners
+```
+
+That's it. Check it out! KISS
+
 ## Contribute
 
-Welcome!
+Welcome, please give your warm feedback.

package/package.json

@@ -22,5 +22,5 @@
         "url": "git+https://github.com/yhwh-script/event-bux.git"
     },
     "type": "module",
-    "version": "1.0.5"
+    "version": "1.0.6"
 }