Skip to main content

Installation

Adding SyncKit to your project using Cocoapods#

CocoaPods is a dependency manager for Swift and Objective-C Cocoa projects. Install Cocoapods if you don't have it already:

$ gem install cocoapods

And add SyncKit to your Podfile. Use the corresponding subspec based on what technology you use for you model, for example:

source 'https://github.com/CocoaPods/Specs.git'platform :ios, '10.0'
use_frameworks!
target 'CoreDataTargetName' dopod 'SyncKit/CoreData', '~> 1.3.2'end
target 'RealmTargetName' dopod 'SyncKit/Realm', '~> 1.3.2'end
target 'RealmSwiftTargetName' dopod 'SyncKit/RealmSwift', '~> 1.3.2'end

Then install using:

$ pod install

Adding SyncKit to your project using Carthage#

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. Install Carthage if you don't have it already:

$ brew install carthage

Add SyncKit to your Cartfile:

github "mentrena/SyncKit" ~> 1.3.2

Run carthage update --use-xcframeworks to create the framework, then drag the right version of the framework into your project, depending on what model your app uses.

Adding SyncKit using Swift Package Manager#

You can add SyncKit as a package dependency:

https://github.com/mentrena/SyncKit

Requirements#

Your application must have the right entitlements to use iCloud and CloudKit, and it must link against the CloudKit framework. Your app is also responsible for handling the cases where a user has not signed into an iCloud account or the current iCloud account changes. SyncKit 0.6.0 requires iOS 10+ or MacOS 10.12+. Previous versions support iOS 8.0+ and MacOS 10.10+.