diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..1fd3900 --- /dev/null +++ b/readme.md @@ -0,0 +1,23 @@ +# keks-meet + +a web conference application + +## Parameters + +For configuration add options in section of URL in a style that is common for query parameters (e.g. `/room/asdfg#username=bob`). +Note that the page wont automatically reload if the section changes. + +Booleans can be either `1`, `true`, `yes` or their opposites. + +| Option name | Type | Default | Description | +| ---------------- | ------- | ------- | ---------------------------------------- | +| `username` | string | "guest" | Sets the username | +| `rnnoise` | boolean | true | Enables noise suppression with rnnoise | +| `mic_enabled` | boolean | false | Adds audio track on startup | +| `camera_enabled` | boolean | false | Adds camera track on startup | +| `screen_enabled` | boolean | false | Adds screen track on startup (wont work) | +| `mic_gain` | number | 1 | Sets the microphone volume | + +## Licence + +See `LICENCE` file. |