Skip to content

Commit 5063525

Browse files
committed
update README.md
1 parent c462780 commit 5063525

1 file changed

Lines changed: 13 additions & 15 deletions

File tree

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,38 +8,36 @@
88

99
An npm module that allows you to mitigate the negative performance and user
1010
experience impact of chat tools. `react-live-chat-loader` shows a fake widget
11-
until the page has become idle or users are ready to interact with chat. Currently works with [Intercom](#intercom), [Help Scout](#help-scout), [Drift](#drift), [Messenger](#messenger) and [Userlike](#userlike).
11+
until the page has become idle or users are ready to interact with chat. Currently works with [Intercom](#intercom), [Help Scout](#help-scout), [Drift](#drift), [Messenger](#messenger), [Userlike](#userlike) and [Chatwoot](#chatwoot).
1212

1313
Made by the team at [♠ Calibre](https://calibreapp.com/), your performance companion.
1414

15-
### Table of Contents
15+
## Table of Contents
1616

17-
1. [How it works](#how-it-works)
17+
1. [How it Works](#how-it-works)
1818
2. [Installation](#installation)
1919
3. [Usage](#usage)
2020
4. [Supported Providers](#supported-providers)
21-
5. [Adding a provider](#adding-a-provider)
21+
5. [Adding a Provider](#adding-a-provider)
2222
6. [Examples](#examples)
2323

24-
---
25-
26-
## How it works
24+
## How it Works
2725

2826
Chat widgets rely heavily on JavaScript which comes at a cost. Given the
2927
significant impact that comes from the download, parse, compile and execution of
3028
chat JavaScript, React Live Chat Loader implements a "fake", fast loading button
3129
and waits for one of the following events before loading the actual widget:
3230

33-
- User hovers over the fake button
34-
- User clicks the fake button
31+
- Person hovers over the fake button
32+
- Person clicks the fake button
3533
- The page has been idle for a significant amount of time
3634

3735
Under the hood React Live Chat Loader makes use of `requestIdleCallback` to
38-
track how long the page has been idle for and checks if the user is on a slow
36+
track how long the page has been idle for and checks if the person is on a slow
3937
connection (using `navigator.connection.effectiveType`) or has data-saver enabled
4038
(using `navigator.connection.saveData`) to prevent loading.
4139

42-
Please note: Some chat widget providers open automatically based on the users
40+
:warning: **Please note:** Some chat widget providers open automatically based on the people’s
4341
interaction from their last session.
4442

4543
## Installation
@@ -235,15 +233,15 @@ You can customise the Messenger widget by passing the following props to the
235233
`Messenger` component:
236234

237235
- `color`: The theme color of the widget
238-
- `loggedInGreeting`: The greeting text that will be displayed if the user is currently logged in to Facebook.
239-
- `loggedOutGreeting`: The greeting text that will be displayed if the user is
236+
- `loggedInGreeting`: The greeting text that will be displayed if the person is currently logged in to Facebook.
237+
- `loggedOutGreeting`: The greeting text that will be displayed if the person is
240238
currently not logged in to Facebook.
241239
- `greetingDialogDisplay`: Sets how the greeting dialog will be displayed.
242240
- `greetingDialogDelay`: Sets the number of seconds of delay before the greeting dialog is shown after the plugin is loaded.
243241

244242
For a list of options, refer to [Facebook Customer Chat Plugin documentation](https://developers.facebook.com/docs/messenger-platform/discovery/customer-chat-plugin#customization).
245243

246-
**Please note**: Facebook Messenger will not load on localhost and you will need
244+
:warning: **Please note**: Facebook Messenger will not load on localhost and you will need
247245
to configure your domain through the setup wizard in Facebook for it to load
248246
correctly.
249247

@@ -461,7 +459,7 @@ Add your new provider to this README under [Supported Providers](#supported-prov
461459

462460
Add a new page to `website/pages/` which showcases the provider. If you don't want to include your `providerKey` leave this blank and the maintainers will set one up.
463461

464-
The new provider page can be tested locally by creating a distribution version of the package and referencing this from the `wesbite`.
462+
The new provider page can be tested locally by creating a distribution version of the package and referencing this from the `website`.
465463

466464
Unfortunately if you try to include the package locally from source you'll most likely run into a [Duplicate React](https://reactjs.org/warnings/invalid-hook-call-warning.html#duplicate-react) error.
467465

0 commit comments

Comments
 (0)