Skip to content

Commit ef251ea

Browse files
authored
Add ios docs for Swift Package Manager (#937)
1 parent 55d3933 commit ef251ea

File tree

1 file changed

+9
-44
lines changed

1 file changed

+9
-44
lines changed

_includes/ios/getting-started.md

Lines changed: 9 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,15 @@
11
# Getting Started
22

3-
To use parse, head on over to the [releases][releases] page, and download the latest build.
4-
And you're off! Take a look at the public [documentation][docs] and start building.
3+
The easiest way to integrate the Parse SDK into your iOS, iPadOS, macOS, watchOS, tvOS app is via Swift Package Manager (SPM).
54

6-
**Other Installation Options**
5+
1. Open Xcode > File > Add packages...
6+
2. Add the following package URL:
77

8-
- **[CocoaPods](https://cocoapods.org)**
9-
10-
Add the following line to your Podfile:
11-
```ruby
12-
pod 'Parse'
13-
```
14-
Run `pod install`, and you should now have the latest parse release. CocoaPods will generate a .xcworkspace for you. You must open the .xcworkspace in Xcode or you will get a linker error.
15-
16-
17-
- **[Carthage](https://github.com/carthage/carthage)**
18-
19-
Add the following line to your Cartfile:
20-
```
21-
github "parse-community/Parse-SDK-iOS-OSX"
22-
```
23-
Run `carthage update`, and you should now have the latest version of Parse SDK in your Carthage folder.
24-
25-
- **Compiling for yourself**
26-
27-
If you want to manually compile the SDK, clone it locally, and run the following commands in the root directory of the repository:
28-
29-
# To pull in extra dependencies (Bolts and OCMock)
30-
git submodule update --init --recursive
31-
32-
# To install all the gems
33-
bundle install
34-
35-
# Build & Package the Frameworks
36-
rake package:frameworks
37-
38-
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.
39-
40-
- **Using Parse as a sub-project**
41-
42-
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.
8+
```
9+
https://github.com/parse-community/Parse-SDK-iOS-OSX
10+
```
4311

44-
**Initialise Parse SDK**
12+
**Note: You may have to add submodules under Link Binary with Libraries**
4513

4614
To initialize the Parse client, add the following to your AppDelegate.swift file (AppDelegate.m for Objective-C), in the `application:didFinishLaunchingWithOptions:` method.
4715

@@ -73,12 +41,9 @@ Make sure to import the Parse module at the top of any file in which you want to
7341

7442
<div class="language-toggle" markdown="1">
7543
```objective_c
76-
#import <Parse/Parse.h>
44+
@import ParseCore;
7745
```
7846
```swift
79-
import Parse
47+
import ParseCore
8048
```
8149
</div>
82-
83-
[releases]: https://github.com/parse-community/Parse-SDK-iOS-OSX/releases
84-
[docs]: http://docs.parseplatform.org/ios/guide

0 commit comments

Comments
 (0)