@realsee/live 0.2.0 → 0.3.0-alpha.2

package/README.md

@@ -30,11 +30,13 @@ SDKs（iOS/Android/微信小程序）和 Live API 可以快速实现实时同屏
 
 ```bash
 # npm
-npm i @realsee/live
+npm i @realsee/live tslib
 # yarn
-yarn add @realsee/live
+yarn add @realsee/live tslib
 ```
 
+> **Live** 通过 [TypeScript](http://www.typescriptlang.org/) 编写，依赖 [tslib]() 运行时，如果你的项目不是由 [TypeScript](http://www.typescriptlang.org/) 构成，请安装此运行时。
+
 ### 如何使用
 
 简单使用样例（先不考虑实时语音能力）：
@@ -282,6 +284,62 @@ live.$RTC.micro
 live.$RTC.on('userVolumes', (userVolumes) => {})
 ```
 
+## 浏览器端支持
+
+不同于客户端(Android\iOS) 已经内置 **RTC** 能力，浏览器端需要我们自己安装 第三方 **RTC SDK** 依赖。 **Live** 内置 腾讯[TRTC](https://github.com/tencentyun/TRTCSDK/blob/HEAD/Web/README-zh_CN.md) 和 亚马逊[Chime](https://github.com/aws/amazon-chime-sdk-js) 两个语音能力集成实现。
+
+> 纯浏览器端不需要 **Native** 中转能力，没有 **jsBridge** 依赖。
+
+### TRTC
+
+安装依赖：
+
+```shell
+# 需要您自行安装
+yarn add trtc-js-sdk
+```
+
+使用方式：
+
+```tsx
+import { createLive } from '@realsee/live'
+import { BrowserRTC } from '@realsee/live/RTC/BrowserRTC'
+
+const rtcInstance = new VRWebViewRTC({
+  getVoiceSign: () => {},
+})
+
+const live = createLive({
+  rtc: rtcInstance,
+  getTicket: async () => '',
+})
+```
+
+### Chime
+
+安装依赖：
+
+```shell
+# 需要您自行安装
+yarn add amazon-chime-sdk-js
+```
+
+使用方式：
+
+```tsx
+import { createLive } from '@realsee/live'
+import { BrowserRTC4Chime } from '@realsee/live/RTC/BrowserRTC4Chime'
+
+const rtcInstance = new BrowserRTC4Chime({
+  getVoiceSign: () => {},
+})
+
+const live = createLive({
+  rtc: rtcInstance,
+  getTicket: async () => '',
+})
+```
+
 ## TypeScript & React 支持
 
 **Live** 有完整的 [TypeScript Generics](https://www.typescriptlang.org/docs/handbook/2/generics.html)