Skip to content

Commit 584befd

Browse files
committed
2 parents 1204016 + 58e2339 commit 584befd

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11

22
# instabug-reactnative
33

4+
Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new major version.
5+
46
## Installation
57
This section explains how to install Instabug SDK into your React Native application.
68

@@ -51,6 +53,34 @@ protected List<ReactPackage> getPackages() {
5153
```
5254
You can find your app token by selecting the SDK tab from your [**Instabug dashboard**](https://dashboard.instabug.com/app/sdk/).
5355
56+
## Upgrading guide
57+
58+
Version 2.0.0
59+
60+
- **removes dependency on Cocoapods** when installing Instabug
61+
- **ensures consistency** between the React Native SDK, and the Native SDK
62+
63+
### Upgrading from 1.x.x
64+
65+
When upgrading from version 1.x.x please make sure you do the following steps:
66+
67+
1. Run
68+
```bash
69+
npm install instabug-reactnative
70+
```
71+
2. Open your Pod file and delete this line ```pod 'Instabug', '~> 7.0'```
72+
73+
3. Run this command from inside the ```ios``` directory inside your root project's directory
74+
```bash
75+
pod install
76+
```
77+
78+
4. Run this command from your root project's directory
79+
```bash
80+
react-native link instabug-reactnative
81+
```
82+
(Make sure you have [**Ruby**](https://www.ruby-lang.org/en/documentation/installation/) installed before running this last command. (You can skip installing Ruby if you're building an Android app only))
83+
5484
## Documentation
5585
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).
5686

0 commit comments

Comments
 (0)