Skip to content

Commit d0eeb3c

Browse files
authored
Update readme with new manual download URL (#497)
* Update readme with new manual download URL * Update manual integration section steps
1 parent cd1d8f7 commit d0eeb3c

File tree

1 file changed

+25
-37
lines changed

1 file changed

+25
-37
lines changed

README.md

Lines changed: 25 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -46,36 +46,24 @@ To integrate Instabug into your Xcode project using SPM, please refer to https:/
4646

4747
### Manually
4848

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

51-
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
51+
1. **Download the Latest Instabug SDK Release:**
52+
- [Go to Instabug SDK latest release](https://github.com/Instabug/Instabug-iOS/releases/latest)
53+
- Click on `Instabug-XCFramework.zip` to download the file.
5254

53-
3. Create a new "Run Script Phase" in your project’s target "Build Phases" and add the following snippet
54-
55-
```
56-
bash "${BUILT_PRODUCTS_DIR}/${FRAMEWORKS_FOLDER_PATH}/Instabug.framework/strip-frameworks.sh"
57-
```
58-
4. In Xcode 11.x you might get the following error:
59-
```
60-
dyld: Library not loaded: @rpath/Instabug.framework/Instabug
61-
Reason: image not found
62-
```
63-
If that's the case, do the following steps:
64-
- Under Build Phases, click on + icon to add new phase, and select New Copy Files Phase.
65-
66-
- Drag the newly created Copy Files phase above Compile Sources phase
67-
68-
- In the new Copy Files phase, select Frameworks from Destination dropdown.
69-
70-
- Leave subpath blank. Let be default Copy only when installing.
71-
72-
- Under the table, click '+' and then select `Instabug.xcframework`
73-
74-
- Make sure `Code Sign on Copy` is checked (ticked).
75-
76-
- Do a clean build.
55+
2. **Extract the Zip File:**
56+
- Unzip the downloaded file to reveal the `Instabug.xcframework`.
7757

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

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

8068
## Usage
8169

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

9482
2. Add the following to your app delegate's application:didFinishLaunchingWithOptions: method.
95-
96-
```swift
97-
// Swift
98-
Instabug.start(withToken: <#app token#>, invocationEvents: .shake)
99-
```
100-
```objective-c
101-
// Objective-C
102-
[Instabug startWithToken:<#app token#> invocationEvents:IBGInvocationEventShake];
103-
```
104-
Make sure to replace `app_token` with your application token. Find it [here](https://instabug.com/app/sdk/).
83+
84+
```swift
85+
// Swift
86+
Instabug.start(withToken: <#app token#>, invocationEvents: .shake)
87+
```
88+
```objective-c
89+
// Objective-C
90+
[Instabug startWithToken:<#app token#> invocationEvents:IBGInvocationEventShake];
91+
```
92+
Make sure to replace `app_token` with your application token. Find it [here](https://instabug.com/app/sdk/).
10593

10694
## Notes
10795
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.
@@ -117,7 +105,7 @@ If your app doesn’t already access the microphone or photo library, we recomme
117105
* "`<app name>` needs access to your photo library for you to be able to attach images."
118106

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

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

0 commit comments

Comments
 (0)