more docs

2021-12-09 13:22:03 +07:00
parent b6b48ea310
commit 6003258089
5 changed files with 66 additions and 26 deletions
@@ -6,7 +6,9 @@ import 'room.dart';
 class LiveKitClient {
  static const version = '0.5.4';

-  /// Connects to a LiveKit room
+  /// Convenience method for connecting to a LiveKit server.
+  /// Returns a [Room] upon a successful connect or throws when it fails.
+  /// Alternatively, it is possible to instantiate [Room] and call [Room.connect] directly.
  static Future<Room> connect(
    String url,
    String token, {