Skip to content

Commit b45b1b5

Browse files
committed
update README
1 parent 64ccae3 commit b45b1b5

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,16 @@
11
# livekit-agents
2+
23
Example agents I've built using the LiveKit Agents (https://github.com/livekit/agents) framework
4+
5+
## To run any of these agents
6+
7+
1. `cd` into agent subdirectory
8+
2. `cp .env.example .env`
9+
3. open the `.env` file and replace `XXXXXX` with proper values for each environment variable
10+
4. `python agent.py start`
11+
12+
## To interact with the agent in the agents playground
13+
14+
1. open a browser and navigate to: `https://agents-playground.livekit.io/`
15+
2. choose to the same LiveKit Cloud project that the agent is running against (or manually enter a websocket URL and participant token if self-hosting)
16+
3. click `Connect` in the top right corner of the playground UI

0 commit comments

Comments
 (0)