Merge pull request #99 from Iterable/use-frameworks

Clarified Podfile instructions

Author: Brad Umbaugh

README.md

@@ -16,21 +16,35 @@ For more information, read Iterable's [Setting up iOS Push Notifications](https:
 
 Iterable supports [CocoaPods](https://cocoapods.org) for easy installation. If you don't have it yet, please refer to the CocoaPods [Getting Started](https://guides.cocoapods.org/using/getting-started.html) guide for installation instructions.
 
-To include the Iterable SDK in your project, edit the **Podfile** and add the **Iterable-iOS-SDK** pod to your app target:
+To install the Iterable Swift SDK using CocoaPods:
 
-```
-pod 'Iterable-iOS-SDK'
-```
+- Edit your project's **Podfile** and add the **Iterable-iOS-SDK** pod to 
+your app target.
+- If you'll be using media attachments on iOS push notifications, add the 
+**Iterable-iOS-AppExtensions** pod to your project's extension target.
 
-If you want to include a Iterable Rich Notification Extension, you will also need to include the **Iterable-iOS-AppExtensions** pod in your extension target:
+Example **Podfile**:
 
-```
-pod 'Iterable-iOS-AppExtensions'
-```
+```ruby
+platform :ios, '11.0'
 
-Please look at the included sample [**Podfile**](https://github.com/Iterable/swift-sdk/blob/master/sample-apps/swift-sample-app/Podfile?raw=true).
+# You must include the following line for both Objective-C and Swift
+# projects. If you cannot use this option for your target, install
+# the Iterable SDK in your project manually
+use_frameworks!
+
+target 'swift-sample-app' do
+  pod 'Iterable-iOS-SDK'
+end
+
+target 'swift-sample-app-notification-extension' do
+  pod 'Iterable-iOS-AppExtensions'
+end
+```
 
-Congratulations! You have now imported Iterable SDK into your project! 
+You you must include `use_frameworks!` in your **Podfile**, no matter if
+your app is based on Swift or Objective-C. If you cannot use this in your 
+project, install the SDK [manually](#manual-installation).
 
 ## Manual installation
 
@@ -49,7 +63,7 @@ IterableAppExtensions.framework
 
     ![Linking](https://github.com/Iterable/swift-sdk/blob/master/images/app-extension-linked-framework.png?raw=true)
 
-3. In build settings, set **Always Embed Swift Standard Libraries** setting to **Yes**. This is required for Objective-C projects.
+3. In build settings, set **Always Embed Swift Standard Libraries** setting to **Yes**. This is necessary for both Swift and Objective-C projects.
 
     ![Linking](https://github.com/Iterable/swift-sdk/blob/master/images/build-setting.png?raw=true)
 
@@ -226,7 +240,7 @@ See Apple's [UserNotifications framework](https://developer.apple.com/documentat
 
     The Iterable iOS SDK provides an implementation that handles media attachments and action buttons:
 
-    1. Include `Iterable-iOS-AppExtensions` in your podfile as explained above.
+    1. Include `Iterable-iOS-AppExtensions` in your **Podfile** as explained above.
     2. Create a new target of type notification service extension in your Xcode project/solution.
     3. If you are calling Iterable SDK from Swift, all you need to do is inherit the `NotificationService` class (auto generated by Xcode) from the `ITBNotificationServiceExtension` class. If you are using Objective-C, you will have to delegate to the provided implementation. See the example below:
 

sample-apps/objc-sample-app/Podfile

@@ -1,6 +1,8 @@
 platform :ios, '11.0'
 
-# Comment the next line if you're not using Swift and don't want to use dynamic frameworks
+# You must include the following line for both Objective-C and Swift
+# projects. If you cannot use this option for your target, install
+# the Iterable SDK in your project manually.
 use_frameworks!
 
 target 'objc-sample-app' do

sample-apps/swift-sample-app/Podfile

@@ -1,6 +1,8 @@
 platform :ios, '11.0'
 
-# Comment the next line if you're not using Swift and don't want to use dynamic frameworks
+# You must include the following line for both Objective-C and Swift
+# projects. If you cannot use this option for your target, install
+# the Iterable SDK in your project manually
 use_frameworks!
 
 target 'swift-sample-app' do