add docs

docs/ANDROID_INSTALLATION.md

@@ -1,18 +1,4 @@
-# Android Installation
+# [Android old setup for v 1.x](./v1/android.md)
 
-# Prerequisites
-* Android SDK
-* Android Studio
 
-# Step 1. Add `AndroidManifest.xml`
-```xml
-<uses-permission android:name="android.permission.RECORD_AUDIO" />
-<uses-permission android:name="android.permission.CAMERA" />
-<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
-<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
-```
-
-# Obfuscation Code Edit `android/proguard-rules.pro`
-```java
--keep class io.agora.**{*;}
-```
+# [Android latest version setup](./v2/android.md)

docs/ANDROID_INSTALLATION.zh.md

@@ -1,18 +1,4 @@
-# Android 开发搭建指南
+# [Android 1.x 版本构建步骤](./v1/android.zh.md)
 
-# 环境准备
-* Android SDK
-* Android Studio
 
-# Step 1. 新增 `AndroidManifest.xml`
-```xml
-<uses-permission android:name="android.permission.RECORD_AUDIO" />
-<uses-permission android:name="android.permission.CAMERA" />
-<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
-<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
-```
-
-# 当您在写混淆代码时，请在``添加以下代码:
-```script
-    -keep class io.agora.**{*;}
-```
+# [Android 最新版本构建步骤](./v2/android.zh.md)

docs/IOS_INSTALLATION.md

@@ -1,64 +1,4 @@
-# iOS Installation
+# [iOS old setup for v 1.x](./v1/ios.md)
 
-# Prerequisites
-* You should installed and linked `react-native-agora`
-* Xcode 10.0+
 
-# Step 1. Open Project in Xcode
-Open `ios/projectName.xcodeproj` with XCode
-![Step 1](./IOS_INSTALLATION/1.1_Open_iOS_ProjectFile.png)
-# Step 2. Add Link Binary With Libraries 
-Build Phases -> Link Binary With Libraries -> +
-![Step 2](./IOS_INSTALLATION/1.2_LinkBinaryWithLibraries.png)
-
-    libresolv.tbd
-    libc++.tbd
-    AVFoundation.framework
-    AudioToolbox.framework
-    VideoToolbox.framework
-    CoreMotion.framework
-    CoreMedia.framework
-    CoreTelephony.framework
-
-
-# Step 3. Add Other Link Binary With Libraries From `node_modules`
-Build Phases -> Link Binary With Libraries -> + -> Add Other
-![Step 3](./IOS_INSTALLATION/1.3_Add_Other_Libraries.png)
-
-    node_modules/react-native-agora/ios/RCTAgora/libs/libcrypto.a
-    node_modules/react-native-agora/ios/RCTAgora/libs/AgoraRtcCryptoLoader.framework
-    node_modules/react-native-agora/ios/RCTAgora/libs/AgoraRtcEngineKit.framework
-
-
-# Step 4. Add Framework Search Paths
-Build Settings -> Framework Search Paths -> + 
-![Step 4](./IOS_INSTALLATION/1.4_Add_Framework_Search_Paths.png)
-"$(SRCROOT)/../node_modules/react-native-agora/ios/RCTAgora/libs"
-
-
-# Step 5. Add Library Search Paths
-Build Settings -> Library Search Paths -> + 
-![Step 5](./IOS_INSTALLATION/1.5_Add_Library_Search_Paths.png)
-
-"$(SRCROOT)/../node_modules/react-native-agora/ios/RCTAgora/libs"
-
-
-# Step 6. Set Build Settings Enable Bitcode No
-Build Settings -> Enable Bitcode -> ...
-![Step 6](./IOS_INSTALLATION/1.6_Set_Build_Settings_Enable_Bitcode_No.png)
-
-# Step 7. Set Capabilities Background Modes
-Capabilities -> Background Modes -> Audio, Airplay, and Picture in Picture
-![Step 7](./IOS_INSTALLATION/1.7_Set_Capabilities_Background_Modes.png)
-
-# Step 8.1 Set info.plist
-Change info.plist  
-"Privacy - Camera Usage Description":"use camera to start video call"  
-"Privacy - Microphone Usage Description":"use microphone to start video call"  
-
-![Step 8.1](./IOS_INSTALLATION/1.8.1_Set_info_plist.png)
-
-![Step 8.2](./IOS_INSTALLATION/1.8.2_Set_camera_and_microphone.png)
-
-# Step 9 build
-`react-native run-ios`
+# [iOS latest version setup](./v2/ios.md)

docs/IOS_INSTALLATION.zh.md

@@ -1,60 +1,4 @@
-# iOS 开发搭建指南
+# [iOS 1.x 版本构建步骤](./v1/ios.zh.md)
 
-# 环境
-* 请先在项目里安装 `react-native-agora` & `react-native link react-native-agora`
-* Xcode 10.0+
 
-# Step 1. 使用Xcode打开ios项目
-用Xcode打开RN项目里的`ios/RN项目.xcodeproj`文件
-![Step 1](./IOS_INSTALLATION/1.1_Open_iOS_ProjectFile.png)
-# Step 2. 添加如下的链接库到Xcode工程
-选择 Build Phases -> Link Binary With Libraries -> +
-![Step 2](./IOS_INSTALLATION/1.2_LinkBinaryWithLibraries.png)
-
-    libresolv.tbd
-    libc++.tbd
-    AVFoundation.framework
-    AudioToolbox.framework
-    VideoToolbox.framework
-    CoreMotion.framework
-    CoreMedia.framework
-    CoreTelephony.framework
-# Step 3. 添加node_modules库到Xcode工程
-选择 Build Phases-> Link Binary With Libaries中点击“+”按钮，在弹出的窗口中点击“Add Other”按钮，选择
-![Step 3](./IOS_INSTALLATION/1.3_Add_Other_Libraries.png)
-
-    node_modules/react-native-agora/ios/RCTAgora/libs/libcrypto.a
-    node_modules/react-native-agora/ios/RCTAgora/libs/AgoraRtcCryptoLoader.framework
-    node_modules/react-native-agora/ios/RCTAgora/libs/AgoraRtcEngineKit.framework
-
-# Step 4. 添加Framework Search Paths
-选择 Build Settings->Search Paths->Framework Search Paths添加
-"$(SRCROOT)/../node_modules/react-native-agora/ios/RCTAgora/libs"
-![Step 4](./IOS_INSTALLATION/1.4_Add_Framework_Search_Paths.png)
-
-# Step 5. 添加Library Search Paths
-选择 Build Settings->Search Paths->Library Search Paths添加
-"$(SRCROOT)/../node_modules/react-native-agora/ios/RCTAgora/libs"
-![Step 5](./IOS_INSTALLATION/1.5_Add_Library_Search_Paths.png)
-
-
-# Step 6. 设置Build Settings Enable Bitcode No
-选择 Build Settings->Enable Bitcode设置为No
-![Step 6](./IOS_INSTALLATION/1.6_Set_Build_Settings_Enable_Bitcode_No.png)
-
-# Step 7. 设置Capabilities Background Modes
-选择 Capabilities->Background Modes->Modes勾选Audio,AirPlay,and Picture In Picture
-![Step 7](./IOS_INSTALLATION/1.7_Set_Capabilities_Background_Modes.png)
-
-# Step 8.1 设置info.plist
-修改info.plist
-新增2项:  
-"Privacy - Camera Usage Description":"use camera to start video call"  
-"Privacy - Microphone Usage Description":"use microphone to start video call"
-
-![Step 8.1](./IOS_INSTALLATION/1.8.1_Set_info_plist.png)
-
-![Step 8.2](./IOS_INSTALLATION/1.8.2_Set_camera_and_microphone.png)
-
-# Step 9 编译
-`react-native run-ios`
+# [iOS 最新版本构建步骤](./v2/ios.zh.md)

docs/v1/android.md

@@ -0,0 +1,18 @@
+# Android Installation
+
+# Prerequisites
+* Android SDK
+* Android Studio
+
+# Step 1. Add `AndroidManifest.xml`
+```xml
+<uses-permission android:name="android.permission.RECORD_AUDIO" />
+<uses-permission android:name="android.permission.CAMERA" />
+<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
+<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+```
+
+# Obfuscation Code Edit `android/proguard-rules.pro`
+```java
+-keep class io.agora.**{*;}
+```

docs/v1/android.zh.md

@@ -0,0 +1,18 @@
+# Android 开发搭建指南
+
+# 环境准备
+* Android SDK
+* Android Studio
+
+# Step 1. 新增 `AndroidManifest.xml`
+```xml
+<uses-permission android:name="android.permission.RECORD_AUDIO" />
+<uses-permission android:name="android.permission.CAMERA" />
+<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
+<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+```
+
+# 当您在写混淆代码时，请在``添加以下代码:
+```script
+    -keep class io.agora.**{*;}
+```

docs/v1/ios.md

@@ -0,0 +1,64 @@
+# iOS Installation
+
+# Prerequisites
+* You should installed and linked `react-native-agora`
+* Xcode 10.0+
+
+# Step 1. Open Project in Xcode
+Open `ios/projectName.xcodeproj` with XCode
+![Step 1](./IOS_INSTALLATION/1.1_Open_iOS_ProjectFile.png)
+# Step 2. Add Link Binary With Libraries 
+Build Phases -> Link Binary With Libraries -> +
+![Step 2](./IOS_INSTALLATION/1.2_LinkBinaryWithLibraries.png)
+
+    libresolv.tbd
+    libc++.tbd
+    AVFoundation.framework
+    AudioToolbox.framework
+    VideoToolbox.framework
+    CoreMotion.framework
+    CoreMedia.framework
+    CoreTelephony.framework
+
+
+# Step 3. Add Other Link Binary With Libraries From `node_modules`
+Build Phases -> Link Binary With Libraries -> + -> Add Other
+![Step 3](./IOS_INSTALLATION/1.3_Add_Other_Libraries.png)
+
+    node_modules/react-native-agora/ios/RCTAgora/libs/libcrypto.a
+    node_modules/react-native-agora/ios/RCTAgora/libs/AgoraRtcCryptoLoader.framework
+    node_modules/react-native-agora/ios/RCTAgora/libs/AgoraRtcEngineKit.framework
+
+
+# Step 4. Add Framework Search Paths
+Build Settings -> Framework Search Paths -> + 
+![Step 4](./IOS_INSTALLATION/1.4_Add_Framework_Search_Paths.png)
+"$(SRCROOT)/../node_modules/react-native-agora/ios/RCTAgora/libs"
+
+
+# Step 5. Add Library Search Paths
+Build Settings -> Library Search Paths -> + 
+![Step 5](./IOS_INSTALLATION/1.5_Add_Library_Search_Paths.png)
+
+"$(SRCROOT)/../node_modules/react-native-agora/ios/RCTAgora/libs"
+
+
+# Step 6. Set Build Settings Enable Bitcode No
+Build Settings -> Enable Bitcode -> ...
+![Step 6](./IOS_INSTALLATION/1.6_Set_Build_Settings_Enable_Bitcode_No.png)
+
+# Step 7. Set Capabilities Background Modes
+Capabilities -> Background Modes -> Audio, Airplay, and Picture in Picture
+![Step 7](./IOS_INSTALLATION/1.7_Set_Capabilities_Background_Modes.png)
+
+# Step 8.1 Set info.plist
+Change info.plist  
+"Privacy - Camera Usage Description":"use camera to start video call"  
+"Privacy - Microphone Usage Description":"use microphone to start video call"  
+
+![Step 8.1](./IOS_INSTALLATION/1.8.1_Set_info_plist.png)
+
+![Step 8.2](./IOS_INSTALLATION/1.8.2_Set_camera_and_microphone.png)
+
+# Step 9 build
+`react-native run-ios`

docs/v1/ios.zh.md

@@ -0,0 +1,60 @@
+# iOS 开发搭建指南
+
+# 环境
+* 请先在项目里安装 `react-native-agora` & `react-native link react-native-agora`
+* Xcode 10.0+
+
+# Step 1. 使用Xcode打开ios项目
+用Xcode打开RN项目里的`ios/RN项目.xcodeproj`文件
+![Step 1](./IOS_INSTALLATION/1.1_Open_iOS_ProjectFile.png)
+# Step 2. 添加如下的链接库到Xcode工程
+选择 Build Phases -> Link Binary With Libraries -> +
+![Step 2](./IOS_INSTALLATION/1.2_LinkBinaryWithLibraries.png)
+
+    libresolv.tbd
+    libc++.tbd
+    AVFoundation.framework
+    AudioToolbox.framework
+    VideoToolbox.framework
+    CoreMotion.framework
+    CoreMedia.framework
+    CoreTelephony.framework
+# Step 3. 添加node_modules库到Xcode工程
+选择 Build Phases-> Link Binary With Libaries中点击“+”按钮，在弹出的窗口中点击“Add Other”按钮，选择
+![Step 3](./IOS_INSTALLATION/1.3_Add_Other_Libraries.png)
+
+    node_modules/react-native-agora/ios/RCTAgora/libs/libcrypto.a
+    node_modules/react-native-agora/ios/RCTAgora/libs/AgoraRtcCryptoLoader.framework
+    node_modules/react-native-agora/ios/RCTAgora/libs/AgoraRtcEngineKit.framework
+
+# Step 4. 添加Framework Search Paths
+选择 Build Settings->Search Paths->Framework Search Paths添加
+"$(SRCROOT)/../node_modules/react-native-agora/ios/RCTAgora/libs"
+![Step 4](./IOS_INSTALLATION/1.4_Add_Framework_Search_Paths.png)
+
+# Step 5. 添加Library Search Paths
+选择 Build Settings->Search Paths->Library Search Paths添加
+"$(SRCROOT)/../node_modules/react-native-agora/ios/RCTAgora/libs"
+![Step 5](./IOS_INSTALLATION/1.5_Add_Library_Search_Paths.png)
+
+
+# Step 6. 设置Build Settings Enable Bitcode No
+选择 Build Settings->Enable Bitcode设置为No
+![Step 6](./IOS_INSTALLATION/1.6_Set_Build_Settings_Enable_Bitcode_No.png)
+
+# Step 7. 设置Capabilities Background Modes
+选择 Capabilities->Background Modes->Modes勾选Audio,AirPlay,and Picture In Picture
+![Step 7](./IOS_INSTALLATION/1.7_Set_Capabilities_Background_Modes.png)
+
+# Step 8.1 设置info.plist
+修改info.plist
+新增2项:  
+"Privacy - Camera Usage Description":"use camera to start video call"  
+"Privacy - Microphone Usage Description":"use microphone to start video call"
+
+![Step 8.1](./IOS_INSTALLATION/1.8.1_Set_info_plist.png)
+
+![Step 8.2](./IOS_INSTALLATION/1.8.2_Set_camera_and_microphone.png)
+
+# Step 9 编译
+`react-native run-ios`

docs/v2/android.md

@@ -0,0 +1,46 @@
+# Android Installation
+
+# Prerequisites
+* Android SDK
+* Android Studio
+
+# Step 1. Add `AndroidManifest.xml`
+```xml
+<uses-permission android:name="android.permission.RECORD_AUDIO" />
+<uses-permission android:name="android.permission.CAMERA" />
+<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
+<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+```
+
+# Step 2. Add `react-native-agora` to `settings.gradle`
+```groovy
+...
+include ':react-native-agora'
+project(':react-native-agora').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-agora/android')
+```
+
+# To set android sdk version Create `local.properties` in android root directory
+```bash
+cd android
+echo "sdk.dir = <Your Local Android Path>" > local.properties
+```
+
+# For Obfuscation Code Edit `android/proguard-rules.pro`
+```java
+-keep class io.agora.**{*;}
+```
+
+# build for development
+```bash
+react-native run-android
+react-native log-android
+```
+
+# build for Release
+```bash
+mkdir -p android/app/src/main/assets
+curl "localhost:8081/index.bundle?platform=android&dev=false&minify=true" -o "android/app/src/main/assets/index.android.bundle"
+cd android
+./gradlew assembleRelease
+
+```

docs/v2/android.zh.md

@@ -0,0 +1,45 @@
+# Android 开发搭建指南
+
+# Prerequisites
+* Android SDK
+* Android Studio
+
+# Step 1. 新增 `AndroidManifest.xml`
+```xml
+<uses-permission android:name="android.permission.RECORD_AUDIO" />
+<uses-permission android:name="android.permission.CAMERA" />
+<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
+<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+```
+
+# Step 2. 在android目录里的`settings.gradle`新增`react-native-agora`的依赖管理
+```groovy
+include ':react-native-agora'
+project(':react-native-agora').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-agora/android')
+```
+
+# 可以创建`local.properties`设置android sdk
+```bash
+cd android
+echo "sdk.dir = <你的android目录>" > local.properties
+```
+
+# 当您在写混淆代码时，请在``添加以下代码 到 `android/proguard-rules.pro`
+```java
+-keep class io.agora.**{*;}
+```
+
+# 构建开发环境
+```bash
+react-native run-android
+react-native log-android
+```
+
+# 开发环境打包
+```bash
+mkdir -p android/app/src/main/assets
+curl "localhost:8081/index.bundle?platform=android&dev=false&minify=true" -o "android/app/src/main/assets/index.android.bundle"
+cd android
+./gradlew assembleRelease
+
+```

docs/v2/ios.md

@@ -0,0 +1,37 @@
+# iOS Installation
+
+# Prerequisites
+* You should installed and linked `react-native-agora`
+* Xcode 10.0+
+* cocoapods
+
+```bash
+# installed ruby first then run it
+gem install cocoapods
+```
+
+# Step 1. install pod dependencies
+```bash
+pod install
+```
+
+# Step 2. Open Workspace Project in Xcode  
+Open `ios/projectName.xcworkspace` with XCode
+![Step 2](./IOS_INSTALLATION/1.2_OpenProject.png)
+
+# Step 3. Add RCTAgora to the Project Libraries folder
+![Step 3.1](./IOS_INSTALLATION/1.3_Add_Files_To_Project.png)
+![Step 3.2](./IOS_INSTALLATION/1.3.1_RCTAgora.png)
+
+# Step 4. Add Linked Library to the xcode project
+![Step 4.1](./IOS_INSTALLATION/1.4.1_SET_LINKED_LIBARIES.png)
+![Step 4.2](./IOS_INSTALLATION/1.4.1_SET_LINKED_LIBARIES.png)
+![Step 4.3](./IOS_INSTALLATION/1.4.2_SET_RCTAgora.a.png)
+
+# Step 5. Set Framework and Libraries Search Paths
+![Step 5.1](./IOS_INSTALLATION/1.5.1_Add_Framework_Search_Paths.png)
+![Step 5.2](./IOS_INSTALLATION/1.5.2_Add_Library_Search_Paths.png)
+
+
+# Step 6. build and run it with xcode
+

docs/v2/ios.zh.md

@@ -0,0 +1,37 @@
+# iOS 开发搭建指南
+
+# 环境
+* 请先在项目里安装 `react-native-agora` & `react-native link react-native-agora`
+* Xcode 10.0+
+* 安装cocoapods
+
+```bash
+# 需要首先安装好ruby
+gem install cocoapods
+```
+
+# Step 1. 首先安装
+```bash
+pod install
+```
+
+# Step 2. 使用xcode开启项目  
+打开 `ios/projectName.xcworkspace`
+![Step 2](./IOS_INSTALLATION/1.2_OpenProject.png)
+
+# Step 3. 在项目里新增RCTAgora项目到Libraries目录里
+![Step 3.1](./IOS_INSTALLATION/1.3_Add_Files_To_Project.png)
+![Step 3.2](./IOS_INSTALLATION/1.3.1_RCTAgora.png)
+
+# Step 4. 把react-native-agora添加到linked libraries里
+![Step 4.1](./IOS_INSTALLATION/1.4.1_SET_LINKED_LIBARIES.png)
+![Step 4.2](./IOS_INSTALLATION/1.4.1_SET_LINKED_LIBARIES.png)
+![Step 4.3](./IOS_INSTALLATION/1.4.2_SET_RCTAgora.a.png)
+
+# Step 5. 设置 Framework & Libraries Search Paths
+![Step 5.1](./IOS_INSTALLATION/1.5.1_Add_Framework_Search_Paths.png)
+![Step 5.2](./IOS_INSTALLATION/1.5.2_Add_Library_Search_Paths.png)
+
+
+# Step 6. xcode 编译并运行
+