Skip to content

Commit

Permalink
Added rnpm support for simpler installation
Browse files Browse the repository at this point in the history
  • Loading branch information
aylarov committed Aug 15, 2016
1 parent 6334c74 commit cc044f7
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ VoxImplant Mobile SDK module for React Native. It lets developers embed realtime
You can get the demo app from [http://github.com/voximplant/react-native-demo](http://github.com/voximplant/react-native-demo)

## Getting started

### iOS

#### Option: Manually

1. Make sure you have "React Native" project created with `react-native init`
2. `cd` into a project directory where `package.json` file is located.
3. Run `npm install react-native-voximplant@latest --save`
Expand All @@ -19,7 +23,16 @@ You can get the demo app from [http://github.com/voximplant/react-native-demo](h
8. Click `VoxImplant.xcodeproj` in the project navigator and go the `Build Settings` tab. Make sure 'All' is toggled on (instead of 'Basic'). Look for `Header Search Paths` and make sure it contains `$(SRCROOT)/../node_modules/react-native/React` and mark as `recursive`. Look for `Library Search Paths` and add `$(SRCROOT)/../node_modules/react-native-voximplant/ios/VoxImplantSDK/lib`
9. Run your project (`Cmd+R`)

#### Option: With [`rnpm`](https://github.com/rnpm/rnpm)

`$ rnpm link`

*Note: Some users are having trouble using this method, try one of the others if you are too.*

### Android

#### Option: Manually

1. Make sure you have "React Native" project created with `react-native init`
2. `cd` into a project directory where `package.json` file is located.
3. Run `npm install react-native-voximplant@latest --save`
Expand Down Expand Up @@ -50,6 +63,12 @@ You can get the demo app from [http://github.com/voximplant/react-native-demo](h
<uses-permission android:name="android.permission.INTERNET" />
```
#### Option: With [`rnpm`](https://github.com/rnpm/rnpm)
`$ rnpm link`
*Note: Some users are having trouble using this method, try one of the others if you are too.*
## Usage
`import` the `react-native-voximplant` module:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-native-voximplant",
"version": "0.1.6",
"version": "0.1.7",
"description": "VoxImplant Mobile SDK for embedding voice and video communication into React Native apps.",
"nativePackage": true,
"keywords": [
Expand Down

0 comments on commit cc044f7

Please sign in to comment.