react-native-bugbattle-sdk/README.md

In-App Bug Reporting and Testing for Apps. Learn more at https://www.bugbattle.io

# React Native BugBattle

The BugBattle SDK for React Native is the easiest way to integrate BugBattle into your apps!
 
## Docs & Examples

Checkout our [documentation](https://docs.bugbattle.io/docs/reactnative-sdk) for full reference.

## Installation

Open a terminal window and navigate to the root.

**Install via npm**

```
$ npm install react-native-bugbattle-sdk --save
```

**iOS installation**

Navigate to your iOS project folder within the terminal and update the cocoapods by typing

```
pod install
```

**Initialize BugBattle SDK**

Import the BugBattle SDK by adding the following import inside one of your root components.

```js
import BugBattle from 'react-native-bugbattle-sdk';
```

In addition, you need to call the initialization function to initialize the Bugbattle SDK. Make sure that the initialization method gets called only once (i.e. by using ```useEffect```).

```js
BugBattle.initialize('YOUR_API_KEY', BugBattle.SHAKE);
```

Your API key can be found in the project settings within BugBattle. Possible values for the activation method are ```BugBattle.NONE``` and ```BugBattle.SHAKE```.

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## License

See [license file](LICENSE) for more informations.