Skip to content

Commit eb2e10a

Browse files
authored
Update README.md
1 parent 247d568 commit eb2e10a

File tree

1 file changed

+10
-25
lines changed

1 file changed

+10
-25
lines changed

README.md

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Instabug for react native
1+
# Instabug for React Native
22

33
[![npm](https://img.shields.io/npm/v/instabug-reactnative.svg)](https://www.npmjs.com/package/instabug-reactnative)
44
[![npm](https://img.shields.io/npm/dt/instabug-reactnative.svg)](https://www.npmjs.com/package/instabug-reactnative)
@@ -7,17 +7,17 @@
77
[![Analytics](https://instabug-ga.appspot.com/UA-41982088-6/github/Instabug/instabug-reactnative?pixel)](https://instabug.com)
88

99

10-
Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new major version.
10+
Upgrading? Check the [Upgrade Guide](#upgrade-guide) before bumping to a new major version.
1111

1212
<img src="http://s3.amazonaws.com/instabug-assets/mockups/annotation.gif" width="25%"/> <img src="http://s3.amazonaws.com/instabug-assets/mockups/dashboard.gif" width="73%"/>
1313

14-
Instabug is a reliable [bug reporting and user feedback platform](https://instabug.com/bug-reporting) that empowers mobile-first companies to iterate faster and enhance their app quality.
15-
Gather bug reports from your users and the Instabug SDK will automatically capture an environment snapshot of your user's device including all console logs, [server-side network requests](https://instabug.com/network-logging), [bug reproduction steps](https://instabug.com/user-steps) and more details that would help you debug and fix bugs faster.
14+
Instabug is an in-app feedback and bug reporting tool for mobile apps. With just a simple shake, your users or beta testers can [report bugs](https://instabug.com/bug-reporting) or send in-app feedback and the SDK will capture an environment snapshot of your user's device including all console logs, [server-side network requests](https://instabug.com/network-logging) and bug reproduction steps compiling all these details in one organised dashboard to help you debug and fix bugs faster.
15+
16+
Instabug also provides you with a [reliable crash reporter](https://instabug.com/crash-reporting) that automatically captures a detailed report of the running environment, the different threads’ states, [the steps to reproduce the crash](https://instabug.com/user-steps), and the network request logs. All the data is captured automatically with no need for breadcrumbs, and you can always [reply back to your users](https://instabug.com/in-app-chat) and they will receive your messages within the app.
1617

1718
For more info, visit [Instabug.com](https://www.instabug.com).
1819

1920
## Installation
20-
This section explains how to install Instabug SDK into your React Native application.
2121

2222
1. Open the terminal and navigate to your React Native Directory. Then run the following command.
2323

@@ -71,12 +71,7 @@ protected List<ReactPackage> getPackages() {
7171
```
7272
You can find your app token by selecting the SDK tab from your [**Instabug dashboard**](https://dashboard.instabug.com/app/sdk/).
7373
74-
## Upgrading guide
75-
76-
Version 2.0.0
77-
78-
- **removes dependency on Cocoapods** when installing Instabug
79-
- **ensures consistency** between the React Native SDK, and the Native SDK
74+
## Upgrade Guide
8075
8176
### Upgrading from 1.x.x
8277
@@ -99,9 +94,9 @@ pod install
9994
react-native link instabug-reactnative
10095
```
10196
102-
### Upgrading from 2.0.x and from 8.0.3
97+
### Upgrading from 8.0.3 to 8.x
10398
104-
When upgrading from 2.0.x to 2.1.x or from 8.0.3 to 8.x, please make sure you do the following steps:
99+
When upgrading from 8.0.3 to 8.x, please make sure you do the following steps:
105100
106101
1. Unlink the project before upgrading to the new version
107102
```bash
@@ -119,6 +114,7 @@ react-native link instabug-reactnative
119114
```
120115
121116
## Microphone and Photo Library Usage Description (iOS Only)
117+
122118
Instabug needs access to the microphone and photo library to be able to let users add audio and video attachments. Starting from iOS 10, apps that don’t provide a usage description for those 2 permissions would be rejected when submitted to the App Store.
123119
124120
For your app not to be rejected, you’ll need to add the following 2 keys to your app’s info.plist file with text explaining to the user why those permissions are needed:
@@ -134,16 +130,5 @@ If your app doesn’t already access the microphone or photo library, we recomme
134130
**The permission alert for accessing the microphone/photo library will NOT appear unless users attempt to attach a voice note/photo while using Instabug.**
135131
136132
## Documentation
137-
For more details about the supported APIs and how to use them, you can check our [**Documentation**](https://docs.instabug.com/docs/react-native-overview).
138-
139-
140-
## Contact Us
141-
If you have any questions or feedback don't hesitate to get in touch. You can reach us at any time through **[email protected]**.
142-
143-
144-
145-
## License
146-
147-
This software is released under <a href="https://opensource.org/licenses/mit-license.php">MIT License</a>.
148133
149-
© 2017 Instabug. All rights reserved.
134+
For more details about the supported APIs and how to use them, check our [**Documentation**](https://docs.instabug.com/docs/react-native-overview).

0 commit comments

Comments
 (0)