Skip to content

Commit 4ab8e82

Browse files
committed
📚 Update documentation about ensuring having xcodeproj gem installed.
1 parent bc71e94 commit 4ab8e82

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,12 @@ yarn add instabug-reactnative
1919

2020
2. Install [**Ruby**](https://www.ruby-lang.org/en/documentation/installation/). (You can skip this step if you're building for Android only)
2121

22-
3. Link the bridging files in the npm package to the ios project use the following command.
22+
3. Install `xcodeproj` gem by running the following command. (You can also skip this step if you're building for Android only)
23+
```bash
24+
gem install xcodeproj
25+
```
26+
27+
4. Link the bridging files in the npm package to the ios project use the following command.
2328
```bash
2429
react-native link instabug-reactnative
2530
```
@@ -37,7 +42,7 @@ Instabug.startWithToken('IOS_APP_TOKEN', Instabug.invocationEvent.shake);
3742
```
3843
3. Open `android/app/src/main/java/[...]/MainApplication.java`
3944
You should find the getPackages method looks like the following snippet. You just need to add your Android app token (You can skip this step if you are building an iOS app only). You can change the invocation event from here, simply by replacing the `"shake"` with any of the following `"button"`, `"none"`, `"screenshot"`, or `"swipe"`. You can change the primary color by replacing the `"#1D82DC"` with any colour of your choice.
40-
In the case that you are using the floating button as an invocation event, you can change the floating button edge and the floating button offset using the last two methods, by replacing `"left"` to `"right"`, and by changing the offset number.
45+
In the case that you are using the floating button as an invocation event, you can change the floating button edge and the floating button offset using the last two methods, by replacing `"left"` to `"right"`, and by changing the offset number.
4146
```javascript
4247
@Override
4348
protected List<ReactPackage> getPackages() {
@@ -62,9 +67,9 @@ Version 2.0.0
6267
6368
### Upgrading from 1.x.x
6469
65-
When upgrading from version 1.x.x please make sure you do the following steps:
70+
When upgrading from version 1.x.x please make sure you do the following steps:
6671
67-
1. Run
72+
1. Run
6873
```bash
6974
npm install instabug-reactnative
7075
```
@@ -79,13 +84,13 @@ pod install
7984
8085
```bash
8186
react-native link instabug-reactnative
82-
```
87+
```
8388
8489
## Documentation
8590
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).
8691
8792
88-
## Contact US
93+
## Contact US
8994
If you have any questions or feedback don't hesitate to get in touch. You can reach us at any time through **[email protected]**.
9095
9196

link.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
begin
33
require 'xcodeproj'
44
rescue LoadError
5-
puts('xcodeproj doesn\'t exist')
5+
puts('xcodeproj gem doesn\'t exist. Please run \'gem install xcodeproj\' to install it, and re-run \'react-native link instabug-reactnative\' again')
66
Kernel.exit(0)
77
end
88

@@ -30,16 +30,16 @@
3030

3131
# Add new "Embed Frameworks" build phase to target
3232
embed_frameworks_build_phase = target.build_phases.find { |build_phase| build_phase.to_s == 'Embed Instabug Framework'}
33-
Kernel.exit(0) if embed_frameworks_build_phase
33+
Kernel.exit(0) if embed_frameworks_build_phase
3434
embed_frameworks_build_phase = project.new(Xcodeproj::Project::Object::PBXCopyFilesBuildPhase)
3535
embed_frameworks_build_phase.name = 'Embed Instabug Framework'
3636
embed_frameworks_build_phase.symbol_dst_subfolder_spec = :frameworks
37-
target.build_phases << embed_frameworks_build_phase
37+
target.build_phases << embed_frameworks_build_phase
3838

3939
# Add framework search path to target
4040
['Debug', 'Release'].each do |config|
4141
framework_search_paths = target.build_settings(config)['FRAMEWORK_SEARCH_PATHS']
42-
42+
4343
framework_search_paths ||= ['$(inherited)']
4444
framework_search_paths = [framework_search_paths] unless framework_search_paths.is_a?(Array)
4545
framework_search_paths << framework_root unless framework_search_paths.include? framework_root
@@ -59,4 +59,4 @@
5959
phase.shell_script = INSTABUG_PHASE_SCRIPT
6060

6161
# Save Xcode project
62-
project.save
62+
project.save

0 commit comments

Comments
 (0)