diff --git a/README.md b/README.md index 594dd47ae..37af04221 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # instabug-reactnative +Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new major version. + ## Installation This section explains how to install Instabug SDK into your React Native application. @@ -51,6 +53,34 @@ protected List getPackages() { ``` You can find your app token by selecting the SDK tab from your [**Instabug dashboard**](https://dashboard.instabug.com/app/sdk/). +## Upgrading guide + +Version 2.0.0 + +- **removes dependency on Cocoapods** when installing Instabug +- **ensures consistency** between the React Native SDK, and the Native SDK + +### Upgrading from 1.x.x + +When upgrading from version 1.x.x please make sure you do the following steps: + +1. Run +```bash +npm install instabug-reactnative +``` +2. Open your Pod file and delete this line ```pod 'Instabug', '~> 7.0'``` + +3. Run this command from inside the ```ios``` directory inside your root project's directory +```bash +pod install +``` + +4. Run this command from your root project's directory + ```bash +react-native link instabug-reactnative +``` +(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)) + ## Documentation 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).