add readmes to examples.

examples/events/README.md

@@ -0,0 +1,16 @@
+## About
+
+Registers a list of callback functions to hook into OBS events.
+
+## Use
+
+Simply run the code and trigger the events, press `<Enter>` to exit.
+
+This example assumes the existence of a `config.toml`, placed next to `__main__.py`:
+
+```toml
+[connection]
+host = "localhost"
+port = 4455
+password = "mystrongpass"
+```

examples/hotkeys/README.md

@@ -0,0 +1,20 @@
+## About
+
+Sets up some hotkeys to trigger certain actions. Registers a callback function to notify of scene switch event.
+
+Requires [Python Keyboard library](https://github.com/boppreh/keyboard).
+
+## Use
+
+Simply run the code and press the assigned hotkeys. Press `ctrl+enter` to exit.
+
+This example assumes the existence of a `config.toml`, placed next to `__main__.py`:
+
+```toml
+[connection]
+host = "localhost"
+port = 4455
+password = "mystrongpass"
+```
+
+It also assumes the existence of scenes named `START`, `BRB` and `END`.

examples/scene_rotate/README.md

@@ -0,0 +1,14 @@
+## About
+
+Collects the names of all available scenes, rotates through them and prints their name.
+
+## Use
+
+This example assumes the existence of a `config.toml`, placed next to `__main__.py`:
+
+```toml
+[connection]
+host = "localhost"
+port = 4455
+password = "mystrongpass"
+```

examples/scene_rotate/__main__.py

@@ -7,9 +7,9 @@ def main():
     resp = cl.get_scene_list()
     scenes = reversed(tuple(di.get("sceneName") for di in resp.scenes))
 
-    for sc in scenes:
+    for scene in scenes:
-        print(f"Switching to scene {sc}")
+        print(f"Switching to scene {scene}")
-        cl.set_current_program_scene(sc)
+        cl.set_current_program_scene(scene)
         time.sleep(0.5)