Skip to content

Commit

Permalink
update docs for autolinking
Browse files Browse the repository at this point in the history
  • Loading branch information
awitherow committed May 26, 2020
1 parent 2477455 commit aa2e645
Showing 1 changed file with 30 additions and 21 deletions.
51 changes: 30 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
##### 有任何问题欢迎加入QQ群进行反馈 471757030
##### 有任何问题欢迎加入 QQ 群进行反馈 471757030

## [for 1.x old version](README.old.md)

# react-native-agora

[![npm](https://img.shields.io/npm/v/react-native-agora.svg)](https://www.npmjs.com/package/react-native-agora)
[![npm](https://img.shields.io/npm/dm/react-native-agora.svg)](https://www.npmjs.com/package/react-native-agora)
[![npm](https://img.shields.io/npm/dt/react-native-agora.svg)](https://www.npmjs.com/package/react-native-agora)
Expand All @@ -14,47 +15,55 @@
The react-native-agora is an open-source wrapper for react-native developers. This SDK takes advantage of React Native and Agora RTC Video SDKs on Android/iOS.

## Compatibility
* `>= react native 0.55.x`
* `iOS SDK 8.0+`
* `Android 5.0+ x86 arm64 armv7a`

- `>= react native 0.55.x`
- `iOS SDK 8.0+`
- `Android 5.0+ x86 arm64 armv7a`

## [quick start](https://github.com/AgoraIO-Community/Agora-RN-Quickstart)

## Installation

Install with npm:

`npm install --save react-native-agora`
`npm install --save react-native-agora`

Or, install with yarn:

`yarn add react-native-agora`
`yarn add react-native-agora`

If you're on `react-native` < 0.60, you must manually link the project, like below. Otherwise, [Autolinking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md) is enabled for this project for both Android and iOS.

### For React Native < 0.60

Either way, then link with:
`react-native link react-native-agora`

`react-native link react-native-agora`
#### iOS Installation

### iOS Installation
[中文](https://github.com/syanbo/react-native-agora/tree/master/docs/IOS_INSTALLATION.zh.md)
[English](https://github.com/syanbo/react-native-agora/tree/master/docs/IOS_INSTALLATION.md)
[中文](https://github.com/syanbo/react-native-agora/tree/master/docs/IOS_INSTALLATION.zh.md)
[English](https://github.com/syanbo/react-native-agora/tree/master/docs/IOS_INSTALLATION.md)

### Android Installation
[中文](https://github.com/syanbo/react-native-agora/tree/master/docs/ANDROID_INSTALLATION.zh.md)
[English](https://github.com/syanbo/react-native-agora/tree/master/docs/ANDROID_INSTALLATION.md)
#### Android Installation

[中文](https://github.com/syanbo/react-native-agora/tree/master/docs/ANDROID_INSTALLATION.zh.md)
[English](https://github.com/syanbo/react-native-agora/tree/master/docs/ANDROID_INSTALLATION.md)

## Agora Native API Documentation

### Android
[中文](https://docs.agora.io/cn/Video/API%20Reference/java/index.html)
[English](https://docs.agora.io/en/Video/API%20Reference/java/index.html)

[中文](https://docs.agora.io/cn/Video/API%20Reference/java/index.html)
[English](https://docs.agora.io/en/Video/API%20Reference/java/index.html)

## iOS
[中文](https://docs.agora.io/cn/Video/API%20Reference/oc/docs/headers/Agora-Objective-C-API-Overview.html)
[English](https://docs.agora.io/en/Video/API%20Reference/oc/docs/headers/Agora-Objective-C-API-Overview.html)

[中文](https://docs.agora.io/cn/Video/API%20Reference/oc/docs/headers/Agora-Objective-C-API-Overview.html)
[English](https://docs.agora.io/en/Video/API%20Reference/oc/docs/headers/Agora-Objective-C-API-Overview.html)

## [API DOCS](https://syanbo.github.io/react-native-agora/globals.html)

## Resources
* Complete [API documentation](https://docs.agora.io/en/) at the Developer Center
* [File bugs about this sample](https://github.com/syanbo/react-native-agora/issues)
* [React Native Getting Started](https://facebook.github.io/react-native/docs/getting-started.html)

- Complete [API documentation](https://docs.agora.io/en/) at the Developer Center
- [File bugs about this sample](https://github.com/syanbo/react-native-agora/issues)
- [React Native Getting Started](https://facebook.github.io/react-native/docs/getting-started.html)

0 comments on commit aa2e645

Please sign in to comment.