updated README

This commit is contained in:
J Taylor 2021-06-23 16:03:57 +01:00
parent ca3e773a5c
commit f5ae893610
3 changed files with 30 additions and 7 deletions

View File

@ -18,7 +18,7 @@ Please note: this demo is not currently mobile optimised
```
# set both DAILY_API_KEY and DAILY_DOMAIN
mv env.example env.local
mv env.example .env.local
# from project root...
yarn
@ -43,9 +43,3 @@ Abstraction hook that manages Daily call state and error handling
**[ParticipantProvider.js](../shared/contexts/ParticipantProvider.js)**
Manages participant state and abstracts common selectors / derived data
## Deploy your own
Deploy the example using Vercel
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fdaily-demos%2Fexamples%2Ftree%2Fmain%2Fdailyjs%2Fbasic-call&env=DAILY_DOMAIN,DAILY_API_KEY&project-name=dailyjs-basic-call&demo-title=Daily%20Basic%20Call%20Demo)

View File

@ -0,0 +1,29 @@
# Text Chat
![Text Chat](./image.png)
## What does this demo do?
- Use ![sendAppMessage](https://docs.daily.co/reference#%EF%B8%8F-sendappmessage) to send messages
- Listen for incoming messages using the call object `app-message` event
- Extend the basic call demo with a chat provider and aside
Please note: this demo is not currently mobile optimised
### Getting started
```
# set both DAILY_API_KEY and DAILY_DOMAIN
mv env.example .env.local
yarn
yarn workspace @dailyjs/text-chat dev
```
## How does this example work?
In this example we extend the ![basic call demo](../basic-call) with the ability to send chat messages.
We pass a custom tray object, a custom app object (wrapping the original in a new `ChatProvider`) as well as add our `ChatAside` panel. We also symlink both the `public` and `pages/api` folders from the basic call.
In a real world use case you would likely want to implement serverside logic so that participants joining a call can retrieve previously sent messages. This round trip could be done inside of the Chat context.

BIN
dailyjs/text-chat/image.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB