Skip to content

Commit 38863fc

Browse files
committed
📝 Edit README
1 parent 4bfb462 commit 38863fc

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Made by the team at [♠ Calibre](https://calibreapp.com/), your performance com
1818
3. [Usage](#-usage)
1919
4. [Supported Providers](#-supported-providers)
2020
5. [Adding a Provider](#-adding-a-provider)
21-
6. [Examples](#-examples)
21+
6. [Examples](#%EF%B8%8F-examples)
2222
7. [Contributing](#-contributing)
2323
8. [Resources](#-resources)
2424
9. [License](#-license)
@@ -170,7 +170,7 @@ Currently the Help Scout component only supports the icon button style.
170170
</details>
171171

172172
<details>
173-
<summary>Intercom</summary>
173+
<summary id="intercom">Intercom</summary>
174174

175175
To use Intercom import the `LiveChatLoaderProvider` and set the `provider` prop
176176
as `intercom` and the `providerKey` prop as your Intercom App ID.
@@ -200,7 +200,7 @@ the `Intercom` component.
200200
</details>
201201

202202
<details>
203-
<summary>Messenger</summary>
203+
<summary id="messenger">Messenger</summary>
204204

205205
To use Messenger, import the `LiveChatLoaderProvider` and then set the `provider` prop as `messenger` and the `providerKey` prop as your Facebook Page ID.
206206

@@ -249,7 +249,7 @@ For a list of options, refer to [Facebook Customer Chat Plugin documentation](ht
249249
</details>
250250

251251
<details>
252-
<summary>Drift</summary>
252+
<summary id="drift">Drift</summary>
253253

254254
To use Drift import the `LiveChatLoaderProvider` and set the `provider` prop
255255
as `drift` and the `providerKey` prop as your Drift App ID.
@@ -276,7 +276,7 @@ You can customise the Drift Messenger by passing the following props to the
276276
</details>
277277

278278
<details>
279-
<summary>Userlike</summary>
279+
<summary id="userlike">Userlike</summary>
280280

281281
To use Userlike import the `LiveChatLoaderProvider` and set the `provider` prop
282282
as `userlike` and the `providerKey` prop as your Userlike Widget secret.
@@ -310,7 +310,7 @@ You can customise the Userlike Widget by passing the following props to the
310310
</details>
311311

312312
<details>
313-
<summary> Chatwoot </summary>
313+
<summary id="chatwoot">Chatwoot</summary>
314314

315315
To use Chatwoot import the `LiveChatLoaderProvider` and set the `provider` prop
316316
as `chatwoot` and the `providerKey` prop as your Chatwoot secret.
@@ -346,19 +346,19 @@ To add a new live chat provider, follow the steps in [Contributing: Adding a Pro
346346

347347
## 🖥️ Examples
348348

349-
The [/website](https://github.com/calibreapp/react-live-chat-loader/tree/master/website) directory of this repository includes a [Next.js](https://nextjs.org) app with example implementations of all currently supported providers.
349+
The [website](https://github.com/calibreapp/react-live-chat-loader/tree/master/website) directory of this repository includes a [Next.js](https://nextjs.org) app with example implementations of all currently supported providers.
350350

351-
For initial setup of the example website, be sure to first run `npm install` + `npm run build` in the root level of the repository, before running `npm install` in the `/website` directory.
351+
For initial setup of the example app, be sure to first run `npm install` + `npm run build` in the root level of the repository, before running `npm install` in the `website` directory.
352352

353-
The following scripts in `/website` will then be available:
353+
The following scripts in example app will then be available:
354354

355355
- `npm run dev` (run a local server)
356356
- `npm run build` (run next build)
357357
- `npm run start` (run next start)
358358

359-
> 📝  Some provides require whitelisted publically accessable domains served over HTTPS — a service like [ngrok](https://ngrok.com/) can be helpful in acheiving this locally
359+
Visit [react-live-chat-loader.vercel.app](https://react-live-chat-loader.vercel.app/) for a hosted version of the example app.
360360

361-
Visit [react-live-chat-loader.vercel.app](https://react-live-chat-loader.vercel.app/) for a hosted version of the examples.
361+
> 📝  Note that some providers require whitelisted publicly accessible domains served over HTTPS — a service like [ngrok](https://ngrok.com/) can be helpful in achieving this locally
362362
363363
## 🙌 Contributing
364364

0 commit comments

Comments
 (0)