From 6910f3c3b1ab942b3cf49e3a3ce83d714806c67a Mon Sep 17 00:00:00 2001
From: antoine lebaud <lebaud.antoine131@gmail.com>
Date: Fri, 5 Jul 2024 17:05:05 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D(livekit)=20add=20instructions=20to?=
 =?UTF-8?q?=20install=20and=20configure=20LiveKit=20CLI?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

LiveKit CLI is essential to interact with the running server and its
ecosystem.

I recommend installing it, as you can list rooms, find participant identity,
create egress to record room, etc.

It helped a lot debugging the Egress service, and discovering its features.
---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 61944d5c..7101029d 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,8 @@ Framework](https://www.django-rest-framework.org/) and [Vite.js](https://vitejs.
 
 ### Prerequisite
 
+#### Docker
+
 Make sure you have a recent version of Docker and [Docker
 Compose](https://docs.docker.com/compose/install) installed on your laptop:
 
@@ -23,6 +25,10 @@ $ docker compose -v
 > ⚠️ You may need to run the following commands with `sudo` but this can be
 > avoided by assigning your user to the `docker` group.
 
+#### LiveKit CLI
+
+Install LiveKit CLI, which provides utilities for interacting with the LiveKit ecosystem (including the server, egress, and more), please follow the instructions available in the [official repository](https://github.com/livekit/livekit-cli).
+
 ### Project bootstrap
 
 The easiest way to start working on the project is to use GNU Make:
@@ -48,11 +54,28 @@ Your Docker services should now be up and running 🎉
 
 [FIXME] Explain how to run the frontend project.
 
+### Configure LiveKit CLI
+
+For the optimal DX, create a default project named `meet` to use with `livekit-cli` commands:
+```bash
+$ livekit-cli project add
+URL: http://localhost:7880
+API Key: devkey
+API Secret: secret
+Give it a name for later reference: meet
+? Make this project default?? [y/N] y
+```
+
+Thus, you won't need to pass the project API Key and API Secret for each command.
+
+
 ### Adding content
 
 You can create a basic demo site by running:
 
-    $ make demo
+```bash
+$ make demo
+```
 
 Finally, you can check all available Make rules using: