From ad28e4acc57aeed9521287888dffc2b262b95b18 Mon Sep 17 00:00:00 2001 From: Sharon Kennedy Date: Sat, 27 Jun 2020 11:42:25 -0400 Subject: [PATCH] update readme with new configs --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a9d0215..dff7dd6 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,14 @@ Options: | `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.` | +| `chatUnavailableMessage` (optional) | Text to show on error or if the service is otherwise unavailable | `The chat service is not available right now. Please try again later.` | +| `waitMessage` (optional) | Text to show if there is at least one facilitator online but they do not respond right away | `Please be patient, our online facilitators are currently responding to other support requests.` | +| `chatOfflineMessage` (optional) | Text to show if there is no-one online respond | `All of the chat facilitators are currently offline.` | +| `size` (optional) | The size of the start button. Can be 'small' or 'large' | `large` | +| `position` (optional) | The position of the start button. Can be 'top left', 'top right', 'bottom left', 'bottom right'. | `bottom right` | +| `maxWaitTime` (optional) | The maximum time (in ms) the chatbox will wait for someone to join before closing the chat and displaying the chat unavailable message | 600000 | +| `waitInterval` (optional) | The interval (in ms) at which the bot sends the wait message | 120000 | + ## Feature list