instabug-reactnative/README.md

52 lines
2.0 KiB
Markdown
Raw Normal View History

2016-10-03 18:20:59 +00:00
2016-10-04 09:41:36 +00:00
# instabug-reactnative
2016-10-03 18:20:59 +00:00
2016-10-11 10:29:34 +00:00
## Installation
2016-10-03 18:20:59 +00:00
2016-10-04 09:41:36 +00:00
`$ npm install https://github.com/Instabug/instabug-reactnative --save`
2016-10-03 18:20:59 +00:00
2016-10-09 12:50:04 +00:00
`$ rnpm link instabug-reactnative`
2016-10-03 18:20:59 +00:00
#### iOS
2016-10-09 12:50:04 +00:00
1. Open your app `.xcodeproj` file
2. Add `instabug.framework` and `instabug.bundle` from 'instabug-reactnative/ios' to the app project directory.
3. In XCode, in the project navigator, select your project. Add `instabug.framework` to your project's `Build Phases``Link Binary With Libraries`
2016-10-12 09:01:59 +00:00
4. In XCode, in the project navigator, select your project. Add `CoreTelephony.framework` to your project's `Build Phases``Link Binary With Libraries`
5. In XCode, in the project navigator, select your project. Add `CoreMotion.framework` to your project's `Build Phases``Link Binary With Libraries`
6. In XCode, in the project navigator, select your project. Add `instabug.bundle` to your project's `Build Phases``Copy Bundle Resources`
7. Run your project (`Cmd+R`)<
2016-10-03 18:20:59 +00:00
2016-10-11 10:29:34 +00:00
#### Android (Pending)
2016-10-03 18:20:59 +00:00
1. Open up `android/app/src/main/java/[...]/MainActivity.java`
2016-10-04 09:41:36 +00:00
- Add `import com.instabug.reactlibrary.RNInstabugReactnativePackage;` to the imports at the top of the file
2016-10-03 18:20:59 +00:00
- Add `new RNInstabugReactnativePackage()` to the list returned by the `getPackages()` method
2. Append the following lines to `android/settings.gradle`:
```
2016-10-04 09:41:36 +00:00
include ':instabug-reactnative'
project(':instabug-reactnative').projectDir = new File(rootProject.projectDir, '../node_modules/instabug-reactnative/android')
2016-10-03 18:20:59 +00:00
```
3. Insert the following lines inside the dependencies block in `android/app/build.gradle`:
```
2016-10-04 09:41:36 +00:00
compile project(':instabug-reactnative')
2016-10-03 18:20:59 +00:00
```
## Usage
```javascript
2016-10-12 10:30:37 +00:00
import Instabug from'instabug-reactnative';
2016-10-03 18:20:59 +00:00
2016-10-09 12:50:04 +00:00
class testApp extends Component {
constructor() {
super();
2016-10-12 10:15:25 +00:00
Instabug.startWithToken('0f0dc916bd9175e3b5d2fdf0cfa49a69', Instabug.constants.invocationEvent.floatingButton);
2016-10-09 12:50:04 +00:00
}
...
}
2016-10-03 18:20:59 +00:00
```
2016-10-04 09:41:36 +00:00
## License
This software is released under <a href="https://opensource.org/licenses/mit-license.php">MIT License</a>.
© 2016 Instabug. All rights reserved.