From bd667cfe39b9b739ddb72d1742731932d48f9a5a Mon Sep 17 00:00:00 2001 From: David Zhao Date: Sun, 15 Nov 2020 22:38:31 -1000 Subject: [PATCH] updated readme with CLI instructions --- README.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2cdfd35e0..cf646e984 100644 --- a/README.md +++ b/README.md @@ -1 +1,36 @@ -# livekit-server \ No newline at end of file +# livekit-server + +## Building + +Ensure Go 1.14+ is installed, and GOPATH/bin is in your PATH. + +Run `make proto && make + +## CLI + +A CLI is provided to make debugging & testing easier. One of the utilities is the ability to publish tracks from static files. + +To use the publish client, download the following files to your computer: +* [happier.ivf](https://www.dropbox.com/s/4ze93d6070s0qj7/happier.ivf?dl=0) - audio track in VP8 +* [happier.ogg](https://www.dropbox.com/s/istrnolnh7avftq/happier.ogg?dl=0) - audio track in ogg + +To run a peer publishing to a room, do the following: + +1. Ensure server is running in dev mode + ``` + ./bin/livekit-server --dev + ``` + +2. Create a room + + ``` + ./bin/livekit-cli create-room --room-id hello + ``` + +3. Join room as publishing client + + ``` + ./ bin/livekit-cli join --room-id hello --audio --video + ``` + +That's it, join the room with another peer id and see it receiving those tracks