Skip to content

Commit 1cacf28

Browse files
Merge pull request #519 from Instabug/doc/readme-format
Update README.md
2 parents 5cb562e + fee14aa commit 1cacf28

File tree

1 file changed

+47
-44
lines changed

1 file changed

+47
-44
lines changed

README.md

Lines changed: 47 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -113,46 +113,6 @@ import Instabug from 'instabug-reactnative';
113113
}
114114
}
115115
```
116-
## Update Guide
117-
### Updating to versions 8.0-8.4.x
118-
119-
When updating to version 8.0 through 8.4.x, you'll need to perform the steps below.
120-
121-
1. Unlink Instabug
122-
```bash
123-
react-native unlink instabug-reactnative
124-
```
125-
126-
2. Install the new version of Instabug
127-
```bash
128-
npm install instabug-reactnative
129-
```
130-
131-
3. Link Instabug
132-
```bash
133-
react-native link instabug-reactnative
134-
```
135-
136-
### Updating to version 8.5
137-
138-
_Only for apps using React Native >= 0.60. If you're using a lower version, you don't need to perform any extra steps when updating._
139-
140-
Version 8.5 adds support for React Native 0.60. To use Instabug 8.5 with React Native 0.60, you'll need to perform the following steps.
141-
142-
1. Unlink Instabug
143-
```bash
144-
react-native unlink instabug-reactnative
145-
```
146-
147-
2. Install the new version of Instabug
148-
```bash
149-
npm install instabug-reactnative
150-
```
151-
152-
3. Add Instabug to your project
153-
```bash
154-
react-native add-instabug
155-
```
156116
157117
## Microphone and Photo Library Usage Description (iOS Only)
158118
@@ -201,9 +161,9 @@ NetworkLogger.setEnabled(false);
201161
202162
Instabug Repro Steps are enabled by default. It captures a screenshot of each screen the user navigates to. These screens are attached to the BugReport when sent.
203163
204-
We support the 2 most popular React Native navigation libraries:
164+
We support the two most popular React Native navigation libraries:
205165
206-
* **react-navigation**
166+
* **[react-navigation](https://github.com/react-navigation/react-navigation)**
207167
208168
* **v5**
209169
set the `onStateChange` to `Instabug.onStateChange` in your NavigationContainer as follows:
@@ -222,9 +182,10 @@ We support the 2 most popular React Native navigation libraries:
222182
onNavigationStateChange={ Instabug.onNavigationStateChange } />
223183
);
224184
```
225-
* **react-native-navigation**
226185
227-
Register `Instabug.componentDidAppearListener` listener using:
186+
* **[react-native-navigation](https://github.com/wix/react-native-navigation)**
187+
188+
Register `Instabug.componentDidAppearListener` listener using:
228189
```javascript
229190
Navigation.events().registerComponentDidAppearListener( Instabug.componentDidAppearListener );
230191
```
@@ -241,9 +202,51 @@ You can disable Repro Steps using the following API:
241202
Instabug.setReproStepsMode(Instabug.reproStepsMode.disabled);
242203
```
243204
205+
## Update Guide
206+
### Updating to versions 8.0-8.4.x
207+
208+
When updating to version 8.0 through 8.4.x, you'll need to perform the steps below.
209+
210+
1. Unlink Instabug
211+
```bash
212+
react-native unlink instabug-reactnative
213+
```
214+
215+
2. Install the new version of Instabug
216+
```bash
217+
npm install instabug-reactnative
218+
```
219+
220+
3. Link Instabug
221+
```bash
222+
react-native link instabug-reactnative
223+
```
224+
225+
### Updating to version 8.5
226+
227+
_Only for apps using React Native >= 0.60. If you're using a lower version, you don't need to perform any extra steps when updating._
228+
229+
Version 8.5 adds support for React Native 0.60. To use Instabug 8.5 with React Native 0.60, you'll need to perform the following steps.
230+
231+
1. Unlink Instabug
232+
```bash
233+
react-native unlink instabug-reactnative
234+
```
235+
236+
2. Install the new version of Instabug
237+
```bash
238+
npm install instabug-reactnative
239+
```
240+
241+
3. Add Instabug to your project
242+
```bash
243+
react-native add-instabug
244+
```
245+
244246
## Features that are not supported yet
245247
246248
- Push Notification Support for In-App Messaging
249+
- [User Steps](https://help.instabug.com/en/articles/2515300-instabug-report-logs-user-steps).
247250
248251
## Documentation
249252

0 commit comments

Comments
 (0)