Skip to content

Commit 85b2a96

Browse files
authored
v2 README changes. (#462)
* v2 preview. * update. * Update README.md
1 parent e73eaff commit 85b2a96

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

+11-7
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,11 @@
1414

1515
<!--BEGIN_DESCRIPTION-->
1616
Use this SDK to add real-time video, audio and data features to your Flutter app. By connecting to a self- or cloud-hosted <a href="https://livekit.io/">LiveKit</a> server, you can quickly build applications like interactive live streaming or video calls with just a few lines of code.
17+
18+
## NOTE
19+
20+
Version 2 of the <platform> SDK contains a small set of breaking changes. Read the [migration guide](https://docs.livekit.io/guides/migrate-from-v1/) for a detailed overview of what has changed.
21+
1722
<!--END_DESCRIPTION-->
1823

1924
This package is published to pub.dev as [livekit_client](https://pub.dev/packages/livekit_client).
@@ -42,6 +47,8 @@ More Docs and guides are available at [https://docs.livekit.io](https://docs.liv
4247

4348
We built a multi-user conferencing app as an example in the [example/](example/) folder. You can join the same room from any supported LiveKit clients.
4449

50+
Online demo: https://livekit.github.io/client-sdk-flutter/
51+
4552
## Installation
4653

4754
Include this package to your `pubspec.yaml`
@@ -182,12 +189,6 @@ Note: the audio routing will become controlled by the system and cannot be manua
182189

183190
In order to enable Flutter desktop development, please follow [instructions here](https://docs.flutter.dev/desktop#set-up).
184191

185-
On M1 Macs, you will also need to install x86_64 version of FFI:
186-
187-
```
188-
sudo arch -x86_64 gem install ffi
189-
```
190-
191192
On Windows [VS 2019](https://visualstudio.microsoft.com/thank-you-downloading-visual-studio/?sku=community&rel=16) is needed (link in flutter docs will download VS 2022).
192193

193194
## Usage
@@ -201,7 +202,10 @@ final roomOptions = RoomOptions(
201202
// ... your room options
202203
)
203204
204-
final room = await LiveKitClient.connect(url, token, roomOptions: roomOptions);
205+
final room = Room();
206+
207+
await room.connect(url, token, roomOptions: roomOptions);
208+
205209
try {
206210
// video will fail when running in ios simulator
207211
await room.localParticipant.setCameraEnabled(true);

0 commit comments

Comments
 (0)