Skip to content

Commit 858e2d5

Browse files
committed
📝 Expand example website docs
1 parent 9c2be67 commit 858e2d5

1 file changed

Lines changed: 19 additions & 6 deletions

File tree

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ 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. [Contributing](#-contributing)
22-
7. [Examples](#-examples)
21+
6. [Examples](#-examples)
22+
7. [Contributing](#-contributing)
2323
8. [Resources](#-resources)
2424
9. [License](#-license)
2525

@@ -344,6 +344,22 @@ You can customise the Chatwoot Widget by passing the following props to the
344344

345345
To add a new live chat provider, follow the steps in [Contributing: Adding a Provider](CONTRIBUTING.md#-adding-a-provider).
346346

347+
## 🖥️ Examples
348+
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.
350+
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.
352+
353+
The following scripts in `/website` will then be available:
354+
355+
- `npm run dev` (run a local server)
356+
- `npm run build` (run next build)
357+
- `npm run start` (run next start)
358+
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
360+
361+
Visit [react-live-chat-loader.vercel.app](https://react-live-chat-loader.vercel.app/) for a hosted version of the examples.
362+
347363
## 🙌 Contributing
348364

349365
Happy to hear you’re interested in contributing to React Live Chat Loader! Please find our contribution guidelines [here](CONTRIBUTING.md).
@@ -381,14 +397,11 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
381397

382398
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
383399

384-
## 🖥️ Examples
385-
386-
- [react-live-chat-loader-example-app](https://github.com/calibreapp/react-live-chat-loader/tree/master/website): example [Next.js](https://nextjs.org) application
387-
388400
## 📚 Resources
389401

390402
- [How to avoid performance regressions when using live chat tools](https://calibreapp.com/blog/fast-live-chat)
391403
- [Reducing the Intercom Messenger bundle size by 65%](https://www.intercom.com/blog/reducing-intercom-messenger-bundle-size/)
392404

393405
## 💼 License
406+
394407
This project is [MIT licensed](LICENSE).

0 commit comments

Comments
 (0)