From 622b9d92b89a830a83de67116df8107a42cd8bc6 Mon Sep 17 00:00:00 2001 From: Sharon Date: Sun, 22 Mar 2020 01:25:07 -0400 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 73dce04..66f9c4c 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,16 @@ Built on: Options: | Name | Description | Default | ----------- | ----------- | --------- | -| `matrixServerUrl` (required) | URL for the Matrix homeserver you want to connect to | `https://www.matrix.org` | -| `userToInvite` (required) | Username of the account that should be invited when a new chat is started | `null` | -| `termsUrl` (optional) | URL for the Terms of Use for the chat service | `null` | +| `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` | +| `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.` | +| `termsUrl` (required) | URL for the Terms of Use for the chat service | `https://tosdr.org/` | | `roomName` (optional) | Name of the chatroom generated in Riot | 'Support Chat' | -| `introText` (optional) | Text to be shown before the Terms of Use url | `null` | -| `agreementText` (optional) | Text to be shown to ask for agreement to continue | `null` | +| `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...` | +| `exitMessage` (optional) | Text to show if the user rejects the Terms of Use. | `The chat is closed. You may close this window.` | +| `anonymousDisplayName` (optional) | The display name for the chat user. | `Anonymous` | +| `chatUnavailableMessage` (optional) | Text to show if no-one is available to respond | `The chat service is not available right now. Please try again later.` | ## Local development