diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -1,3 +1,20 @@ # keks-meet A simple webrtc powered conference application + +## Parameters + +For configuration just add a set of the following options as query parameters to the URL (e.g. `/room/asdfg?username=bob`). + +Booleans can be either `1`, `true` or `yes` or their opposites. + +| Option name | Type | Description | +| --------------- | ------- | -------------------------------------- | +| `username` | string | Sets the username | +| `rnnoise` | boolean | Enables noise suppression with rnnoise | +| `audio_enabled` | boolean | Enables audio transmission by default | +| `video_enabled` | boolean | Enables video transmission by default | + +## Licence + +See `LICENCE` file. |