Skip to content

Commit 1c29617

Browse files
authored
docs: Update README with SPM
1 parent 48470f4 commit 1c29617

File tree

1 file changed

+11
-39
lines changed

1 file changed

+11
-39
lines changed

README.md

Lines changed: 11 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313

1414
![Platforms](http://img.shields.io/cocoapods/p/Parse.svg?style=flat)
1515
![SPM](https://img.shields.io/badge/Swift_Package_Manager-compatible-green?style=flat)
16-
[![Pod](https://img.shields.io/cocoapods/v/Parse.svg)](https://cocoapods.org/pods/Parse)
1716

1817
[![Backers on Open Collective](https://opencollective.com/parse-server/backers/badge.svg)][open-collective-link]
1918
[![Sponsors on Open Collective](https://opencollective.com/parse-server/sponsors/badge.svg)][open-collective-link]
@@ -28,22 +27,15 @@ A library that gives you access to the powerful Parse Server backend from your i
2827
---
2928

3029
- [Getting Started](#getting-started)
31-
- [Other Installation Options](#other-installation-options)
32-
- [Swift Package Manager](#swift-package-manager)
33-
- [Compiling for yourself](#compiling-for-yourself)
34-
- [Using Parse as a sub-project](#using-parse-as-a-sub-project)
30+
- [Alternative Installation Options](#alternative-installation-options)
31+
- [Download Builds](#download-builds)
32+
- [Compile Source](#compile-source)
33+
- [Add Sub-Project](#add-sub-project)
3534
- [How Do I Contribute?](#how-do-i-contribute)
3635
- [Dependencies](#dependencies)
3736

3837
## Getting Started
3938

40-
To use parse, head on over to the [releases][releases] page, and download the latest build.
41-
And you're off!. Take a look at the public [documentation][docs] & [API][api] and start building.
42-
43-
Notice the API docs aren't totally up to date when it comes to latest Swift signature of the methods and more importantly regarding [Push Notifications](http://blog.parse.com/learn/engineering/the-dangerous-world-of-client-push/) which are **no longer supported by Parse server**, keep an eye on [its repo](https://github.com/ParsePlatform/parse-server)
44-
45-
### Other Installation Options
46-
4739
#### Swift Package Manager
4840

4941
1. Open Xcode > File > Add packages...
@@ -52,37 +44,17 @@ Notice the API docs aren't totally up to date when it comes to latest Swift sign
5244
https://github.com/parse-community/Parse-SDK-iOS-OSX
5345
```
5446
3. Add package
55-
3. Choose the submodules to add
47+
3. Choose the submodules you want to install
5648

57-
#### [CocoaPods](https://cocoapods.org)
49+
Take a look at the public [documentation][docs] & [API][api] and start building.
5850

59-
Add the following line to your Podfile:
60-
```ruby
61-
pod 'ParseCore'
62-
```
63-
64-
Run `pod install`, and you should now have the latest parse release.
51+
### Alternative Installation Options
6552

66-
If you wish to use the Facebook or Twitter utils or ParseUI,
67-
you can now leverage Cocoapods 'subspecs'
53+
#### Download Builds
6854

69-
```ruby
70-
pod 'Parse/FacebookUtils'
71-
pod 'Parse/TwitterUtils'
72-
pod 'Parse/UI'
73-
```
74-
75-
Note that in this case, the Parse framework will contain all headers and classes, so you just have to use:
76-
77-
```swift
78-
import ParseCore
79-
```
80-
81-
```objc
82-
@import ParseCore;
83-
```
55+
Dowload the compiled builds from the asset section in the [releases][releases] page.
8456

85-
#### Compiling for yourself
57+
#### Compile Source
8658

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

@@ -110,7 +82,7 @@ Compiled frameworks will be in multiple archives inside the `build/release` fold
11082
- `ParseTwitterUtils-iOS.zip`
11183
- `ParseUI.zip`
11284

113-
#### Using Parse as a sub-project
85+
#### Add Sub-Project
11486

11587
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.
11688

0 commit comments

Comments
 (0)