dave/ocrcc-chatbox
1
0
Fork 0
forked from Github/ocrcc-chatbox
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Sharon 2020-03-22 11:06:20 -04:00 committed by GitHub
parent 622b9d92b8
commit 24984c0b77
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -10,16 +10,19 @@ Built on:
``` ```
<script src="./chatbox.js"></script> <script src="./chatbox.js"></script>
<script> <script>
EmbeddableChatbox.mount({ matrixServerUrl: "https://matrix.org" }); EmbeddableChatbox.mount({
matrixServerUrl: "https://matrix.rhok.space",
botUsername: "@help-bot:rhok.space"
});
</script> </script>
``` ```
Options: Options:
| Name | Description | Default | Name | Description | Default
| ----------- | ----------- | --------- | | ----------- | ----------- | --------- |
| `matrixServerUrl` (required) | URL for the Matrix homeserver you want to connect to | `https://matrix.rhok.space` | | `matrixServerUrl` (required) | URL for the Matrix homeserver you want to connect to | `https://matrix.rhok.space` |
| `botUsername` (required) | User ID for the bot account that handles invites | `@help-bot:rhok.space` | | `botId` (required) | User ID for the bot account that handles invites | `@help-bot:rhok.space` |
| `introMessage` (required) | First message the user sees before agreeing to the Terms of Use | `This chat application does not collect any of your personal data or any data from your use of this service.` | | `introMessage` (optional) | First message the user sees before agreeing to the Terms of Use | `This chat application does not collect any of your personal data or any data from your use of this service.` |
| `termsUrl` (required) | URL for the Terms of Use for the chat service | `https://tosdr.org/` | | `termsUrl` (optional) | URL for the Terms of Use for the chat service | `https://tosdr.org/` |
| `roomName` (optional) | Name of the chatroom generated in Riot | 'Support Chat' | | `roomName` (optional) | Name of the chatroom generated in Riot | 'Support Chat' |
| `agreementMessage` (optional) | Text to show to request agreement to the Terms of Use | `Do you want to continue?` | | `agreementMessage` (optional) | Text to show to request agreement to the Terms of Use | `Do you want to continue?` |
| `confirmationMessage` (optional) | Text to show to ask for agreement to continue | `Waiting for a facilitator to join the chat...` | | `confirmationMessage` (optional) | Text to show to ask for agreement to continue | `Waiting for a facilitator to join the chat...` |