Skip to content

Commit

Permalink
docs(examples): add examples description
Browse files Browse the repository at this point in the history
  • Loading branch information
crimx committed Mar 29, 2023
1 parent 12cb856 commit 25463c5
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 0 deletions.
2 changes: 2 additions & 0 deletions examples/mobx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
- Custom user name and avatar.
- Create tracks on demand.

<https://netless-io.github.io/agora-rtc-react/mobx/>

## Develop

1. Add a `.env.local` file to this directory and fill in the Agora account info following the format of `.env.example`.
Expand Down
5 changes: 5 additions & 0 deletions examples/multi-channel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

Demonstrates how to use Agora RTC React SDK to build a multi-channel application.

- Zustand for state management.
- Each channel is handled by a client. With `AgoraRTCProvider` the rest of the Components consume the client in a dependency injection manner, without caring which client is provided.

<https://netless-io.github.io/agora-rtc-react/multi-channel/>

## Develop

1. Add a `.env.local` at monorepo root with `AGORA_APPID` and `AGORA_CERTIFICATE`, then `pnpm renew` to auto-renewing tokens.
Expand Down
4 changes: 4 additions & 0 deletions examples/overview/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Agora RTC React Overview Example

- Simple example without external state management.

<https://netless-io.github.io/agora-rtc-react/overview/>

## Develop

1. Add a `.env.local` file to this directory and fill in the Agora account info following the format of `.env.example`.
Expand Down

0 comments on commit 25463c5

Please sign in to comment.