Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
weeeBox authored Mar 13, 2018
1 parent 9390b72 commit b822d75
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ _The module is still under the development and would be available soon_

## Getting started

`$ npm install react-native-apptentive-module --save`
`$ npm install react-native-apptentive-sdk --save`

### Mostly automatic installation

`$ react-native link react-native-apptentive-module`
`$ react-native link react-native-apptentive-sdk`

### Manual installation


#### iOS

1. In XCode, in the project navigator, right click `Libraries``Add Files to [your project's name]`
2. Go to `node_modules``react-native-apptentive-module` and add `RNApptentiveModule.xcodeproj`
2. Go to `node_modules``react-native-apptentive-sdk` and add `RNApptentiveModule.xcodeproj`
3. In XCode, in the project navigator, select your project. Add `libRNApptentiveModule.a` to your project's `Build Phases``Link Binary With Libraries`
4. Run your project (`Cmd+R`)<

Expand All @@ -28,19 +28,18 @@ _The module is still under the development and would be available soon_
- Add `new RNApptentiveModulePackage()` to the list returned by the `getPackages()` method
2. Append the following lines to `android/settings.gradle`:
```
include ':react-native-apptentive-module'
project(':react-native-apptentive-module').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-apptentive-module/android')
include ':react-native-apptentive-sdk'
project(':react-native-apptentive-sdk').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-apptentive-sdk/android')
```
3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:
```
compile project(':react-native-apptentive-module')
compile project(':react-native-apptentive-sdk')
```

## Usage
```javascript
import RNApptentiveModule from 'react-native-apptentive-module';
import RNApptentiveModule from 'react-native-apptentive-sdk';

// TODO: What to do with the module?
RNApptentiveModule;
// TODO: Do some awesome things here
```

0 comments on commit b822d75

Please sign in to comment.