Skip to content

Commit 1c81359

Browse files
author
Brad Umbaugh
authored
Merge pull request #100 from Iterable/use-frameworks-stable
Clarified instructions about `use_frameworks!` (for stable branch)
2 parents 57381a3 + 89b8a6f commit 1c81359

File tree

3 files changed

+33
-13
lines changed

3 files changed

+33
-13
lines changed

README.md

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,40 @@ For more information, see [Getting Started Guide](https://support.iterable.com/h
1414

1515
# Automatic Installation (via CocoaPods)
1616

17-
Iterable supports [CocoaPods](https://cocoapods.org) for easy installation. If you don't have it yet, please refer to [this document](https://guides.cocoapods.org/using/getting-started.html) to install Cocoapods.
17+
Iterable supports [CocoaPods](https://cocoapods.org) for easy installation.
18+
If you don't have it yet, please refer to the CocoaPods
19+
[Getting Started](https://guides.cocoapods.org/using/getting-started.html)
20+
guide for installation instructions.
1821

19-
To include the Iterable SDK in your project, edit the `Podfile` and add the Iterable-iOS-SDK pod to your app target:
22+
To install the Iterable Swift SDK using CocoaPods:
2023

21-
```
22-
pod 'Iterable-iOS-SDK'
23-
```
24+
- Edit your project's **Podfile** and add the **Iterable-iOS-SDK** pod to
25+
your app target.
26+
- If you'll be using media attachments on iOS push notifications, add the
27+
**Iterable-iOS-AppExtensions** pod to your project's extension target.
2428

25-
If you want to include Iterable Rich Notification Extension you will also need to include the Iterable-iOS-AppExtensions pod to your extension target:
29+
Example **Podfile**:
2630

27-
```
28-
pod 'Iterable-iOS-AppExtensions'
29-
```
31+
```ruby
32+
platform :ios, '11.0'
3033

34+
# You must include the following line for both Objective-C and Swift
35+
# projects. If you cannot use this option for your target, install
36+
# the Iterable SDK in your project manually
37+
use_frameworks!
3138

32-
Please look at the included sample pod file [HERE](https://github.com/Iterable/swift-sdk/blob/master/sample-apps/swift-sample-app/Podfile?raw=true).
39+
target 'swift-sample-app' do
40+
pod 'Iterable-iOS-SDK'
41+
end
42+
43+
target 'swift-sample-app-notification-extension' do
44+
pod 'Iterable-iOS-AppExtensions'
45+
end
46+
```
3347

34-
Congratulations! You have now imported Iterable SDK into your project!
48+
You you must include `use_frameworks!` in your **Podfile**, no matter
49+
whether your app is based on Swift or Objective-C. If you cannot use this in
50+
your project, install the SDK [manually](#manual-installation).
3551

3652
# Manual Installation
3753

sample-apps/objc-sample-app/Podfile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
platform :ios, '11.0'
22

3-
# Comment the next line if you're not using Swift and don't want to use dynamic frameworks
3+
# You must include the following line for both Objective-C and Swift
4+
# projects. If you cannot use this option for your target, install
5+
# the Iterable SDK in your project manually.
46
use_frameworks!
57

68
target 'objc-sample-app' do

sample-apps/swift-sample-app/Podfile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
platform :ios, '11.0'
22

3-
# Comment the next line if you're not using Swift and don't want to use dynamic frameworks
3+
# You must include the following line for both Objective-C and Swift
4+
# projects. If you cannot use this option for your target, install
5+
# the Iterable SDK in your project manually.
46
use_frameworks!
57

68
target 'swift-sample-app' do

0 commit comments

Comments
 (0)