Browse Source

update docs

matrixbirds 5 years ago
parent
commit
a4e9ecc6e2
1 changed files with 18 additions and 11 deletions
  1. 18
    11
      README.md

+ 18
- 11
README.md View File

@@ -34,26 +34,33 @@ Either way, then link with:
34 34
 
35 35
  `react-native link react-native-agora`
36 36
 
37
-### [iOS Installation](docs/IOS_INSTALLATION.md)
38
-### [iOS 开发环境安装指南](docs/IOS_INSTALLATION.zh.md)
37
+### iOS Installation
38
+  [中文](docs/IOS_INSTALLATION.zh.md)
39
+  [English](docs/IOS_INSTALLATION.md)
39 40
 
40
-### [Android Installation](docs/ANDROID_INSTALLATION.md)
41
-### [Android 开发环境安装指南](docs/ANDROID_INSTALLATION.zh.md)
41
+### Android Installation
42
+  [中文](docs/ANDROID_INSTALLATION.zh.md) 
43
+  [English](docs/ANDROID_INSTALLATION.md)
42 44
 
43
-## Documentation
45
+## Agora Native API Documentation
44 46
 
45
-[声网API文档](https://docs.agora.io/cn/Video/API%20Reference/java/index.html)
47
+### Android
48
+  [中文](https://docs.agora.io/cn/Video/API%20Reference/java/index.html) 
49
+  [English](https://docs.agora.io/en/Video/API%20Reference/java/index.html)
46 50
 
47
-[Agora.io API DOCS](https://docs.agora.io/en/Video/API%20Reference/java/index.html)
51
+## iOS
52
+  [中文](https://docs.agora.io/cn/Video/API%20Reference/oc/docs/headers/Agora-Objective-C-API-Overview.html)
53
+  [English](https://docs.agora.io/en/Video/API%20Reference/oc/docs/headers/Agora-Objective-C-API-Overview.html)
48 54
 
49
-##### RtcEngine Methods
50 55
 
51
-| Property                         | Arguments                                     | Description                           |
56
+#### RtcEngine Methods
57
+
58
+| Method Name | Parameters  | Description  |
52 59
 | -------------------------------- | ---------------------------------------- | ------------------------------------- |
53 60
 | init | [Option](#Option) | create and initialize AgoraRtcEngine instance, notice: invoke this method, it will start subscribe events |
54 61
 | Promise<any> joinChannel | String channelName, Number uid, String? token, String? extraInfo | join channel|
55
-| on | [Events](#Events), Handler: Function | addEventListener for native module events |
56
-| off | [Events](#Events) | removeEventListeners for native module events |
62
+| on | String: [EventType](#Events), Handler: Function | addEventListener for native module events |
63
+| off | String: [EventType](#Events) | removeEventListeners for native module events |
57 64
 | removeAllListeners | void | remove all event listeners |
58 65
 | destroy | void | destroy AgoraRtcEngine instance |
59 66
 | getSdkVersion | Function: callback | get sdk version |