Skip to content

Commit

Permalink
Update readme with new manual download URL (#497)
Browse files Browse the repository at this point in the history
* Update readme with new manual download URL

* Update manual integration section steps
  • Loading branch information
asamir0 authored Jul 2, 2024
1 parent cd1d8f7 commit d0eeb3c
Showing 1 changed file with 25 additions and 37 deletions.
62 changes: 25 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,36 +46,24 @@ To integrate Instabug into your Xcode project using SPM, please refer to https:/

### Manually

1. [Download the Instabug SDK](https://s3.amazonaws.com/instabug-pro/sdk_releases/Instabug-XCFramework.zip)
Follow these steps to integrate the Instabug SDK into your iOS project:

2. Extract it then drag & drop Instabug.xcframework to your project's "Frameworks, Libraries, and Embedded Content" section under the "General" tab, and make sure that the "Copy items if needed" checkbox is checked
1. **Download the Latest Instabug SDK Release:**
- [Go to Instabug SDK latest release](https://github.com/Instabug/Instabug-iOS/releases/latest)
- Click on `Instabug-XCFramework.zip` to download the file.

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.xcframework`

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

- Do a clean build.
2. **Extract the Zip File:**
- Unzip the downloaded file to reveal the `Instabug.xcframework`.

3. **Add the Framework to Your Project:**
- Open your project in Xcode.
- Navigate to your project's **General** tab.
- Scroll down to the **Frameworks, Libraries, and Embedded Content** section.
- Click the `+` button, then select **Add Files**.
- Choose the `Instabug.xcframework` from the extracted folder, then click **Open**.

4. **Set Embed Option:**
- In the **Embed** column next to `Instabug.xcframework`, select `Embed Without Signing`.

## Usage

Expand All @@ -92,16 +80,16 @@ If that's the case, do the following steps:
```

2. Add the following to your app delegate's application:didFinishLaunchingWithOptions: method.
```swift
// Swift
Instabug.start(withToken: <#app token#>, invocationEvents: .shake)
```
```objective-c
// Objective-C
[Instabug startWithToken:<#app token#> invocationEvents:IBGInvocationEventShake];
```
Make sure to replace `app_token` with your application token. Find it [here](https://instabug.com/app/sdk/).
```swift
// Swift
Instabug.start(withToken: <#app token#>, invocationEvents: .shake)
```
```objective-c
// Objective-C
[Instabug startWithToken:<#app token#> invocationEvents:IBGInvocationEventShake];
```
Make sure to replace `app_token` with your application token. Find it [here](https://instabug.com/app/sdk/).

## Notes
Instabug needs access to the microphone and photo library to be able to let users add audio and video attachments. Starting from iOS 10, apps that don’t provide a usage description for those 2 permissions would be rejected when submitted to the App Store.
Expand All @@ -117,7 +105,7 @@ If your app doesn’t already access the microphone or photo library, we recomme
* "`<app name>` needs access to your photo library for you to be able to attach images."

**The permission alert for accessing the microphone/photo library will NOT appear unless users attempt to attach a voice note/photo while using Instabug.**
## More

You can also check out our [API Reference](https://docs.instabug.com/docs/ios-overview) for more detailed information about our SDK.

0 comments on commit d0eeb3c

Please sign in to comment.