add readmes to examples.

This commit is contained in:
onyx-and-iris
2022-08-31 20:13:44 +01:00
parent 7c6ebd1dae
commit 66a06617c6
4 changed files with 53 additions and 3 deletions

16
examples/events/README.md Normal file
View File

@@ -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"
```