docs: explain how to use disthread

vinyguedess · May 8, 2020 · 8777793 · 8777793
1 parent 2a48f9e
commit 8777793
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -27,3 +27,18 @@ To listen and dispatch events is very simple:
         first="param",
         second="param",
         third="param")
+
+Should I wait all callbacks to end ?
+====================================
+Nope. You can "threadily" dispatch your events so they 
+don't need to be waited for the main process.
+
+.. code :: python
+
+    from onany import disthread, listener
+
+    @listener("event.name")
+    def on_event_name():
+        print("I'm gonna be executed on another thread")
+
+    >>> disthread("event.name")
diff --git a/setup.py b/setup.py
@@ -9,7 +9,7 @@
 setup(
     name="onany",
     packages=["onany"],
-    version="0.1.2",
+    version="0.1.3",
     license="MIT",
     description="Event manager library",
     long_description=readme,