instabug-reactnative - npm Package Compare versions

Comparing version 1.2.4 to 2.0.0

package.json

 {
   "name": "instabug-reactnative",
-  "version": "1.2.4",
+  "version": "2.0.0",
   "description": "React Native plugin for integrating the Instabug SDK",
-  "scripts": {
-    "postinstall": "cd ../../ios && pod install"
-  },
   "main": "index.js",
@@ -28,2 +25,5 @@ "repository": {
   "rnpm": {
+    "commands": {
+      "postlink": "ruby ./node_modules/instabug-reactnative/link.rb || echo \"Ruby doesn't exist, if you're building this for Android only, then feel free to ignore this error, otherwise please install Ruby and run 'react-native link instabug-reactnative' again\""
+    },
     "android": {
@@ -30,0 +30,0 @@ "packageInstance": "\t\tnew RNInstabugReactnativePackage.Builder(\"YOUR_ANDROID_APPLICATION_TOKEN\",MainApplication.this)\n\t\t\t\t\t\t\t.setInvocationEvent(\"shake\")\n\t\t\t\t\t\t\t.setPrimaryColor(\"#1D82DC\")\n\t\t\t\t\t\t\t.setFloatingEdge(\"left\")\n\t\t\t\t\t\t\t.setFloatingButtonOffsetFromTop(250)\n\t\t\t\t\t\t\t.build()"

README.md

 
 # instabug-reactnative
 
+Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new major version.
+
 ## Installation
@@ -18,15 +20,8 @@ This section explains how to install Instabug SDK into your React Native application.
 
-2. Link the bridging files in the npm package to the ios project use the following command.
+2. Install [**Ruby**](https://www.ruby-lang.org/en/documentation/installation/). (You can skip this step if you're building for Android only)
+
+3. Link the bridging files in the npm package to the ios project use the following command.
 ```bash
 react-native link instabug-reactnative
 ```
-3. Add Instabug SDK to your iOS project by adding this to your [**Podfile**](https://guides.cocoapods.org/syntax/podfile.html) (You can skip this step if you are building an Android app only).
-```bash
-pod 'Instabug', '~> 7.0'
-```
-4.Then run the following command (You can skip this step if you are building an Android app only).
-```bash
-pod install
-```
-CocoaPods will download and install the SDK and add all the required dependencies into your ios project.
 
@@ -62,2 +57,30 @@ ## Using Instabug
 
+## 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
@@ -64,0 +87,0 @@ 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).

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Fixed alerts

Install scripts

Supply chain risk

Install scripts are run when the package is installed. The majority of malware in npm is hidden in install scripts.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

52087433

18851.43%

Number of package files

118

247.06%

Lines of code

7775

218.52%

Number of lines in readme file

98

30.67%

Number of high supply chain risk alerts

0

-100%

Worsened metrics

Number of low license alerts

1

Infinity%

Number of medium supply chain risk alerts

1

Infinity%

No dependency changes