Skip to content

Commit 4914859

Browse files
authored
Update README.md
1 parent e96facc commit 4914859

File tree

1 file changed

+29
-8
lines changed

1 file changed

+29
-8
lines changed

README.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,30 +17,44 @@ For more info, visit [Instabug.com](https://www.instabug.com).
1717

1818
## Installation
1919

20-
1. Open the terminal and navigate to your React Native Directory. Then run the following command.
20+
### Using react-native CLI
21+
22+
1. In Terminal, navigate to your React Native directory and install the `instabug-reactnative` package:
2123

2224
```bash
2325
npm install instabug-reactnative
2426
```
25-
or
27+
28+
Or if you prefer to use Yarn instead of npm:
2629

2730
```bash
2831
yarn add instabug-reactnative
2932
```
3033

31-
2. Install [**Ruby**](https://www.ruby-lang.org/en/documentation/installation/). (You can skip this step if you're building for Android only)
34+
2. For projects that build for iOS, install `xcodeproj` gem:
3235

33-
3. Install `xcodeproj` gem by running the following command. (You can also skip this step if you're building for Android only)
3436
```bash
3537
gem install xcodeproj
3638
```
3739

38-
4. Link the bridging files in the npm package to the ios project use the following command.
40+
3. Finally, link the bridging files in the `instabug-reactnative` package:
41+
42+
3943
```bash
4044
react-native link instabug-reactnative
4145
```
42-
### Installing using Cocoapods
43-
Alternatively, for iOS you can use [CocoaPods](https://cocoapods.org/) for managing dependencies. After following the first step from the installation steps above, add the following to your `Podfile`:
46+
47+
### Using CocoaPods
48+
49+
Alternatively, for iOS you can use [CocoaPods](https://cocoapods.org/) for managing dependencies.
50+
51+
1. In Terminal, navigate to your React Native directory and install the `instabug-reactnative` package:
52+
53+
```bash
54+
npm install instabug-reactnative
55+
```
56+
57+
2. Add the following to your `Podfile`:
4458

4559
```ruby
4660
pod 'instabug-reactnative', :path => '../node_modules/instabug-reactnative'
@@ -54,7 +68,8 @@ pod 'DoubleConversion', :podspec => '../node_modules/react-native/third-party-po
5468
pod 'glog', :podspec => '../node_modules/react-native/third-party-podspecs/GLog.podspec'
5569
pod 'Folly', :podspec => '../node_modules/react-native/third-party-podspecs/Folly.podspec'
5670
```
57-
And add the following post install script at the end of your `Podfile`:
71+
72+
3. Add the following post install script at the end of your `Podfile`:
5873

5974
```ruby
6075
post_install do |installer|
@@ -66,6 +81,12 @@ post_install do |installer|
6681
end
6782
```
6883

84+
4. Install `instabug-reactnative`:
85+
86+
```bash
87+
pod install
88+
```
89+
6990
## Using Instabug
7091
1. To start using Instabug, import it into your `index.ios.js` and `index.android.js` file.
7192

0 commit comments

Comments
 (0)