Skip to content

Commit

Permalink
Merge pull request #742 from ParsePlatform/nlutsenko.readme.carthage
Browse files Browse the repository at this point in the history
Add Carthage instructions and badge to README.
  • Loading branch information
nlutsenko committed Jan 9, 2016
2 parents 5a33bb6 + e4e24a2 commit 5ade422
Showing 1 changed file with 29 additions and 14 deletions.
43 changes: 29 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# Parse SDK for iOS/OS X/watchOS/tvOS

[![Build Status][build-status-svg]][build-status-link]
[![Coverage Status][coverage-status-svg]][coverage-status-link]
[![Podspec][podspec-svg]][podspec-link]
[![License][license-svg]][license-link]
![Platforms][platforms-svg]
[![License][license-svg]][license-link]

[![Podspec][podspec-svg]][podspec-link]
[![Carthage compatible][carthage-svg]](carthage-link)
[![Dependencies][dependencies-svg]][dependencies-link]
[![References][references-svg]][references-link]

[![Build Status][build-status-svg]][build-status-link]
[![Coverage Status][coverage-status-svg]][coverage-status-link]

[![Join Chat][gitter-svg]][gitter-link]

A library that gives you access to the powerful Parse cloud platform from your iOS or OS X app.
Expand All @@ -20,15 +23,24 @@ And you're off! Take a look at the public [documentation][docs] and start buildi

**Other Installation Options**

1. **CocoaPods**

Add the following line to your podfile:

pod 'Parse'

Run pod install, and you should now have the latest parse release.

2. **Compiling for yourself**
- **[CocoaPods](https://cocoapods.org)**

Add the following line to your Podfile:
```ruby
pod 'Parse'
```
Run `pod install`, and you should now have the latest parse release.


- **[Carthage](https://github.com/carthage/carthage)**

Add the following line to your Cartfile:
```
github "ParsePlatform/Parse-SDK-iOS-OSX"
```
Run `carthage update`, and you should now have the latest version of Parse SDK in your Carthage folder.

- **Compiling for yourself**

If you want to manually compile the SDK, clone it locally, and run the following commands in the root directory of the repository:

Expand All @@ -43,7 +55,7 @@ And you're off! Take a look at the public [documentation][docs] and start buildi

Compiled frameworks will be in 2 archives: `Parse-iOS.zip` and `Parse-OSX.zip` inside the `build/release` folder, and you can link them as you'd please.

3. **Using Parse as a sub-project**
- **Using Parse as a sub-project**

You can also include parse as a subproject inside of your application if you'd prefer, although we do not recommend this, as it will increase your indexing time significantly. To do so, just drag and drop the Parse.xcodeproj file into your workspace. Note that unit tests will be unavailable if you use Parse like this, as OCMock will be unable to be found.

Expand Down Expand Up @@ -100,6 +112,9 @@ of patent rights can be found in the PATENTS file in the same directory.

[podspec-svg]: https://img.shields.io/cocoapods/v/Parse.svg
[podspec-link]: https://cocoapods.org/pods/Parse

[carthage-svg]: https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat
[carthage-link]: https://github.com/carthage/carthage

[platforms-svg]: http://img.shields.io/cocoapods/p/Parse.svg?style=flat

Expand Down

0 comments on commit 5ade422

Please sign in to comment.