Skip to content

Update ReadMe #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 3, 2020
Merged

Update ReadMe #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 5 additions & 60 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,67 +10,12 @@ For more info, visit [Instabug.com](https://www.instabug.com).

## Installation

### CocoaPods

To integrate Instabug into your Xcode project using [CocoaPods](https://cocoapods.org), add it to your `Podfile`:

```ruby
pod 'Instabug'
```

Then, run the following command:

```bash
$ pod install
```

### Carthage

To integrate Instabug into your Xcode project using [Carthage](https://github.com/Carthage/Carthage), add it to your `Cartfile`:

```
binary "https://raw.githubusercontent.com/Instabug/Instabug-SP/master/Instabug.json"
```

Then, run the following command:

```bash
$ carthage update
```

Then drag Instabug.framework into your Xcode project.

### Manually

1. [Download the Instabug SDK](https://s3.amazonaws.com/instabug-pro/sdk_releases/Instabug.zip)

2. Extract it then drag & drop Instabug.framework to your project's "Embedded Binaries" section under the "General" tab, and make sure that the "Copy items if needed" checkbox is checked

3. Create a new "Run Script Phase" in your project’s target "Build Phases" and add the following snippet

```
bash "${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/Instabug.framework/strip-frameworks.sh"
```
4. In Xcode 11.x you might get the following error:
```
dyld: Library not loaded: @rpath/Instabug.framework/Instabug
Reason: image not found
```
If that's the case, do the following steps:
- Under Build Phases, click on + icon to add new phase, and select New Copy Files Phase.

- Drag the newly created Copy Files phase above Compile Sources phase

- In the new Copy Files phase, select Frameworks from Destination dropdown.

- Leave subpath blank. Let be default Copy only when installing.

- Under the table, click '+' and then select `Instabug.framework`

- Make sure `Code Sign on Copy` is checked (ticked).

- Do a clean build.
### SPM

1. Open project target.
2. Select Swift packages
3. Add New package and paste https://github.com/Instabug/Instabug-SP
4. Make sure to be on the latest.


## Usage
Expand Down