releasing 0.2.0

LICENSE

@@ -1,21 +1,9 @@
-MIT License
+The MIT License (MIT)
 
-Copyright (c) 2016 Bitly
+Copyright (c) 2016 Bitly, Inc.
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1 +1,137 @@
 # Bitly iOS SDK
+
+![Supported Platforms](https://img.shields.io/cocoapods/p/Charts.svg) ![Releases](https://img.shields.io/github/release/bitly/bitly_ios_sdk.svg) [![Latest pod release](https://img.shields.io/cocoapods/v/BitlySDK.svg)](http://cocoapods.org/pods/BitlySDK) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![Build Status](https://travis-ci.com/bitly/bitly_ios_sdk.svg?token=GQk2M5gzMUKUJCESKF18&branch=master)](https://travis-ci.com/bitly/bitly_ios_sdk)
+
+## Getting Started
+If you do not have any mobile apps setup in your Bitly account you will need to refer to the user guide for setting up deep links in your account.  
+
+Once you have setup your mobile app in your account, go to Your Settings -> Advanced -> Deep Link Applications.  There you will find the Bitly App ID which needs to be included in your SDK configuration.
+
+The domain referenced in the code examples below will be the Bitly Bitly Branded Domain which is enabled for Universal Links.
+
+## Enable Universal Links
+To create the apple site association file on your domain you must send your Apple app ID to your Bitly Account Manager to enable.
+
+The Apple app ID is your team ID and bundle ID joined with a period.  In the Apple’s Developer Portal your team ID appears on Organization Profile > Account Summary.  When you enter the Member Center on http://developer.apple.com, click you name on the top right and click on “View Account” and you will find your team ID under the Developer Account Summary.
+
+## Install the SDK
+
+### CocoaPods
+1. Add the following your Podfile
+
+  ```
+  pod 'BitlySDK'
+  ```
+2. Run the following to download and install the SDK
+
+  ```
+  pod install
+  ```
+
+### Carthage
+1. Add the following your Cartfile
+
+  ```
+  github "bitly/bitly_ios_sdk_release"
+  ```
+2. Run the following to download and build the framework
+
+  ```
+  carthage update
+  ```
+3. Drag the built `BitlySDK.framework` into your Xcode project
+
+## Configure the Universal links
+1. In Xcode open your project file
+2. Go to the Capabilities tab
+3. Ensure that Associated Domains is enabled and expand it
+4. Click on the + button and add your domain as `applinks:yourdomain.com`
+5. Ensure that the yourprojectname.entitlements file is added to the appropriate build target
+
+## Configure the SDK
+1. Import the SDK in your AppDelegate
+
+  **Swift**
+  ```swift
+  import BitlySDK
+  ```
+
+  **Objective-C**
+  ```objective-c
+  #import <BitlySDK/BitlySDK-Swift.h>
+  ```
+2. Initialize the SDK on application initialization
+
+  **Swift**
+  ```swift
+  func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
+      Bitly.initialize("YOUR_APP_ID", supportedDomains:["yourdomain.com","yourotherdomain.com"], supportedSchemes:["yourscheme"]) { response, error in
+          // response provides a BitlyResponse object which contains the full URL information
+          // response includes a status code
+          // error provides any errors in retrieving information about the URL
+          // Your custom logic goes here...
+      }
+      return true
+  }
+  ```
+
+  **Objective-C**
+  ```objective-c
+  - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
+      [Bitly initialize:@"YOUR_APP_ID" supportedDomains:[NSArray arrayWithObjects: @"yourdomain.com", @"yourotherdomain.com", nil] supportedDomains:[NSArray arrayWithObjects: @"yourscheme", nil] handler:^(BitlyResponse * response, NSString * error) {
+          // response provides a BitlyResponse object which contains the full URL information
+          // response includes a status code
+          // error provides any errors in retrieving information about the URL
+          // Your custom logic goes here...
+      }];
+      return YES;
+  }
+  ```
+
+  > By default the Bitly SDK utilizes the IDFV to identify the user. If you which to use the IDFA to track the user simply call the `initializeWithDeviceId` method when initializing the SDK.
+
+3. Handle incoming links
+
+  **Swift**
+  ```swift    
+  func application(application: UIApplication, continueUserActivity userActivity: NSUserActivity, restorationHandler: ([AnyObject]?) -> Void) -> Bool {
+      return Bitly.handleUserActivity(userActivity)
+  }
+
+  func application(application: UIApplication, openURL url: NSURL, sourceApplication: String?, annotation: AnyObject) -> Bool {
+      return Bitly.handleOpenUrl(url);
+  }
+
+  func applicationDidBecomeActive(application: UIApplication) {
+      Bitly.handleApplicationDidBecomeActive()
+  }
+  ```
+
+  **Objective-C**
+  ```objective-c
+  - (BOOL)application:(UIApplication *)application continueUserActivity:(NSUserActivity *)userActivity restorationHandler:(void (^)(NSArray *restorableObjects))restorationHandler {
+      return [Bitly handleUserActivity:userActivity];
+  }
+
+  - (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation {
+      return [Bitly handleOpenUrl:url];
+  }
+
+  - (void)applicationDidBecomeActive:(UIApplication *)application {
+      [Bitly handleApplicationDidBecomeActive];
+  }
+  ```
+
+4. Retry on error
+
+  **Swift**
+  ```swift    
+  Bitly.retryError(error)
+  ```
+
+  **Objective-C**
+  ```objective-c
+  [Bitly retryError:error];
+  ```
+
+  >If there are any issues in handling a Universal Link the operation can be retried using the following line of code in your response handler from step 2