Merge pull request #11 from Iterable/feature/itbl-5387-docs

[ITBL-5387]-docs

Author: tapashmajumder

.gitignore

@@ -8,8 +8,6 @@ Pods/
 *.xccheckout
 .idea/
 
-scripts/
-
 dev.config
 
 Build/

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing
+Contributions (in the form of issues or pull requests) are welcome!
+
+#### **Bugs**
+* Please make sure the bug hasn't already been reported.
+* If it hasn't, open a new issue. Please provide as much detail about the bug as possible.
+
+#### **Feature Suggestions**
+* Feel free to open issues for enhancements and new features! 
+* But like with bugs, please make sure it hasn't already been suggested.
+
+#### **Pull Requests**
+* If you have a patch for a bug, or an implementation of a new feature, you're more than welcome to submit a pull request!
+* If the pull request is for an outstanding issue, please include a link to that issue. Otherwise, there's no need to create a new issue; simply explain the purpose of the Pull Request in the body. 
+
+Thanks,
+Team Iterable

README.md

@@ -100,7 +100,7 @@ - (void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNot
 }
 
 - (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler {
-    [IterableAppIntegration userNotificationCenter:center didReceive:response withCompletionHandler:completionHandler];
+    [IterableAppIntegration userNotificationCenter:center didReceiveNotificationResponse:response withCompletionHandler:completionHandler];
 }
 
 #pragma mark - IterableURLDelegate

images/app-extension-linked-framework.png

@@ -4,9 +4,9 @@ platform :ios, '11.0'
 use_frameworks!
 
 target 'swift-sample-app' do
-  pod 'Iterable-iOS-SDK', :path => '../../../swift-sdk'
+  pod 'Iterable-iOS-SDK'
 end
 
 target 'swift-sample-app-notification-extension' do
-  pod 'Iterable-iOS-AppExtensions', :path => '../../../swift-sdk'
+  pod 'Iterable-iOS-AppExtensions'
 end

images/build-setting.png

@@ -0,0 +1,38 @@
+#!/bin/sh
+
+print_usage() {
+    echo Usage `basename $0` target_name module_name
+    exit 1
+}
+
+if [ "$1" == "" ] || [ "$2" == "" ]; then
+    print_usage
+fi
+
+TARGET="$1"
+MODULE_NAME="$2"
+BUILD_DIR=build
+CONFIGURATION=Release
+UNIVERSAL_OUTPUTFOLDER=${BUILD_DIR}/${CONFIGURATION}-universal
+
+# make sure the output directory exists
+mkdir -p "${UNIVERSAL_OUTPUTFOLDER}"
+
+# Step 1. Build Device and Simulator versions
+xcodebuild -target "${TARGET}" ONLY_ACTIVE_ARCH=NO -configuration ${CONFIGURATION} -sdk iphoneos  BUILD_DIR="${BUILD_DIR}" BUILD_ROOT="${BUILD_DIR}" clean build
+xcodebuild -target "${TARGET}" -configuration ${CONFIGURATION} -sdk iphonesimulator ONLY_ACTIVE_ARCH=NO BUILD_DIR="${BUILD_DIR}" BUILD_ROOT="${BUILD_DIR}" clean build
+
+# Step 2. Copy the framework structure (from iphoneos build) to the universal folder
+cp -R "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${MODULE_NAME}.framework" "${UNIVERSAL_OUTPUTFOLDER}/"
+
+# Step 3. Copy Swift modules from iphonesimulator build (if it exists) to the copied framework directory
+SIMULATOR_SWIFT_MODULES_DIR="${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${MODULE_NAME}.framework/Modules/${MODULE_NAME}.swiftmodule/."
+if [ -d "${SIMULATOR_SWIFT_MODULES_DIR}" ]; then
+cp -R "${SIMULATOR_SWIFT_MODULES_DIR}" "${UNIVERSAL_OUTPUTFOLDER}/${MODULE_NAME}.framework/Modules/${MODULE_NAME}.swiftmodule"
+fi
+
+# Step 4. Create universal binary file using lipo and place the combined executable in the copied framework directory
+lipo -create -output "${UNIVERSAL_OUTPUTFOLDER}/${MODULE_NAME}.framework/${MODULE_NAME}" "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${MODULE_NAME}.framework/${MODULE_NAME}" "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${MODULE_NAME}.framework/${MODULE_NAME}"
+
+# Step 5. Convenience step to copy the framework to the build directory
+cp -R "${UNIVERSAL_OUTPUTFOLDER}/${MODULE_NAME}.framework" "${BUILD_DIR}"

images/embedded-binaries.png

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+BUILDER=`dirname $0`/build-target-module-framework.sh
+BUILD_DIR=build
+
+# clean build dir
+rm -rf "${BUILD_DIR}"
+
+# generate the framework files
+"${BUILDER}" "swift-sdk" "IterableSDK"
+"${BUILDER}" "notification-extension" "IterableAppExtensions"
+
+# generate archive
+cd "${BUILD_DIR}"
+zip -r IterableSDK.zip IterableSDK.framework
+zip -r IterableAppExtensions.zip IterableAppExtensions.framework
+