Updating README
Project: http://git-wip-us.apache.org/repos/asf/usergrid-swift/repo Commit: http://git-wip-us.apache.org/repos/asf/usergrid-swift/commit/7a69131e Tree: http://git-wip-us.apache.org/repos/asf/usergrid-swift/tree/7a69131e Diff: http://git-wip-us.apache.org/repos/asf/usergrid-swift/diff/7a69131e Branch: refs/heads/master Commit: 7a69131ea4169a2c92f5d998df9ce3b7aff503d9 Parents: 43ad9cc Author: Robert Walsh <[email protected]> Authored: Wed Sep 14 13:06:06 2016 -0500 Committer: Robert Walsh <[email protected]> Committed: Wed Sep 14 13:06:06 2016 -0500 ---------------------------------------------------------------------- README.md | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/usergrid-swift/blob/7a69131e/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index cf1f071..b6552bd 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ [](http://cocoadocs.org/docsets/UsergridSDK) [](https://cocoapods.org/pods/UsergridSDK) +[](https://github.com/Carthage/Carthage) Usergrid SDK written in Swift @@ -16,9 +17,7 @@ Usergrid SDK written in Swift ## Installation -> **Embedded frameworks require a minimum deployment target of iOS 8 or OS X Mavericks (10.9).** - -### CocoaPods +### [CocoaPods](http://cocoapods.org) > **CocoaPods 0.39.0+ is required to build the UsergridSDK library.** @@ -37,8 +36,30 @@ Then, run the following command: $ pod install ``` +### [Carthage](https://github.com/Carthage/Carthage) + +Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. + +You can install Carthage with [Homebrew](http://brew.sh/) using the following command: + +```bash +$ brew update +$ brew install carthage +``` + +To integrate the UsergridSDK into your Xcode project using Carthage, specify it in your `Cartfile`: + +```ogdl +github "apache/usergrid-swift" "master" +``` + +Run `carthage update` to build the framework and drag the built `UsergridSDK.framework` into your Xcode project. + + ### Embedded Framework +> **Embedded frameworks require a minimum deployment target of iOS 8 or OS X Mavericks (10.9).** + - Open up Terminal, `cd` into your top-level project directory, and run the following command "if" your project is not initialized as a git repository: ```bash @@ -51,7 +72,7 @@ $ git init $ git submodule add https://github.com/apache/usergrid ``` -- Open the `sdks/swift` folder, and drag the `UsergridSDK.xcodeproj` into the Project Navigator of your application's Xcode project. +- Drag the `UsergridSDK.xcodeproj` into the Project Navigator of your application's Xcode project. > It should appear nested underneath your application's blue project icon.
