From d53269b587c1c9a6047733242408483674084e3a Mon Sep 17 00:00:00 2001 From: Donald Huh Date: Mon, 9 Oct 2023 14:40:00 +0800 Subject: [PATCH] Update README.md --- README.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4f17f8bbb..b2064b85e 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,32 @@ Use this SDK to add real-time video, audio and data features to your React app. By connecting to a self- or cloud-hosted LiveKit server, you can quickly build applications like interactive live streaming or video calls with just a few lines of code. -
+
+
![LiveKit Components Preview](./.github/assets/livekit-meet.jpg) +## Quick Start + +First add the library to your project: +```shell +npm i @livekit/react-components +``` + +Then use any of our pre-fabricated or helper components: ```tsx - - - +import { LiveKitRoom, VideoConference } from '@livekit/react-components' + +const TOKEN = 'generated-jwt' +const WS_URL = 'wss://my-livekit-server' + +export default function Example() { + return ( + + + + ) +} ``` ## Docs