further improvements to README
This commit is contained in:
parent
3f0b551c54
commit
da445d4bb7
|
|
@ -1,21 +1,23 @@
|
|||
# Daily JS Examples
|
||||
|
||||
Run an examples via `yarn workspace @dailyjs/basic-call dev` (replacing `basic-call` with the name of the demo) from the project root
|
||||
### [🤙 Basic call](./basic-call)
|
||||
|
||||
Note: please ensure your rooms are setup to use [web sockets](https://docs.daily.co/reference#domain-configuration)
|
||||
The basic call demo (derived from our prebuilt UI codebase) demonstrates how to create a video and audio call using Call Object mode.
|
||||
|
||||
Note: examples are served using [nextjs](https://nextjs.org/)
|
||||
### [💬 Text chat](./text-chat)
|
||||
|
||||
Send messages to other participants using sendAppMessage
|
||||
|
||||
Run an examples with `yarn workspace @dailyjs/[demo-name] dev` (replacing `[demo-name]` with the name of the demo you'd like to run e.g. `basic-call`.
|
||||
|
||||
- Please ensure your Daily rooms are setup to use [web sockets](https://docs.daily.co/reference#domain-configuration)
|
||||
- Follow the instructions within each demo first, making sure to set all the necassary local environment variables etc
|
||||
- Examples are served using [nextjs](https://nextjs.org/)
|
||||
|
||||
---
|
||||
|
||||
## Getting started
|
||||
|
||||
```
|
||||
// run locally, from project root
|
||||
yarn
|
||||
yarn workspace @dailyjs/[example-to-run] dev
|
||||
```
|
||||
|
||||
We recommend starting with the [basic call](./basic-call) example, showcasing the common flow of a call Daily call, device management and error handling.
|
||||
|
||||
## Shared code
|
||||
|
|
@ -24,12 +26,6 @@ These examples re-use some common components, contexts, hooks and libraries. The
|
|||
|
||||
---
|
||||
|
||||
## Where to get started?
|
||||
## Deploy your own on Vercel
|
||||
|
||||
### [🤙 Basic call](./basic-call)
|
||||
|
||||
The basic call demo (derived from our prebuilt UI codebase) demonstrates how to create a video and audio call using Call Object mode.
|
||||
|
||||
### [💬 Text chat](./text-chat)
|
||||
|
||||
Send messages to other participants using sendAppMessage
|
||||
[](https://vercel.com/new/daily-co/clone-flow?repository-url=https%3A%2F%2Fgithub.com%2Fdaily-demos%2Fexamples.git&env=DAILY_DOMAIN%2CDAILY_API_KEY&envDescription=Your%20Daily%20domain%20and%20API%20key%20can%20be%20found%20on%20your%20account%20dashboard&envLink=https%3A%2F%2Fdashboard.daily.co&project-name=daily-examples&repo-name=daily-examples)
|
||||
|
|
|
|||
|
|
@ -2,10 +2,12 @@
|
|||
|
||||

|
||||
|
||||
## Live example
|
||||
### Live example
|
||||
|
||||
**[See it in action here ➡️](https://dailyjs-basic-call.vercel.app)**
|
||||
|
||||
---
|
||||
|
||||
## What does this demo do?
|
||||
|
||||
- Built on [NextJS](https://nextjs.org/)
|
||||
|
|
|
|||
|
|
@ -2,8 +2,12 @@
|
|||
|
||||

|
||||
|
||||
### Live example
|
||||
|
||||
**[See it in action here ➡️](https://dailyjs-text-chat.vercel.app)**
|
||||
|
||||
---
|
||||
|
||||
## What does this demo do?
|
||||
|
||||
- Use [sendAppMessage](https://docs.daily.co/reference#%EF%B8%8F-sendappmessage) to send messages
|
||||
|
|
|
|||
Loading…
Reference in New Issue