Welcome to the official Sugo Swift SDK

The Sugo Swift SDK for iOS is an open source project, and we'd love to see your contributions!

**Our master branch and our 1.x.x-Releases are now in Swift 3.

Our current release only supports Cocoapods version 1.1.0+

Sugo supports CocoaPods for easy installation.

pod 'sugo-swift-sdk'

To help users stay up to date with the latests version of our Swift SDK, we always recommend integrating our SDK via CocoaPods, which simplifies version updates and dependency management. However, there are cases where users can't use CocoaPods. Not to worry, just follow these manual installation steps and you'll be all set.

Add Sugo as a submodule to your local git repo like so:

git submodule add [email protected]:Datafruit/sugo-swift-sdk.git

Now the Sugo project and its files should be in your project folder!

Drag the Sugo.xcodeproj inside your sample project under the main sample project file:

Select your app .xcodeproj file. Under "General", add the Sugo framework as an embedded binary:

Import Sugo into AppDelegate.swift, and initialize Sugo within application:didFinishLaunchingWithOptions:

func application(_ application: UIApplication,
                 didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
    let id: String = "Add_Your_Project_ID_Here"
    let token: String = "Add_Your_App_Token_Here"
    Sugo.initialize(id: id, token: token)
}

By calling:

let sugo = Sugo.initialize(id: "Project_ID", token: "App_Token")

You initialize your sugo instance with the token provided to you on sugo.com. To interact with the instance and start tracking, you can either use the sugo instance given when initializing:

let sugo = Sugo.mainInstance()
sugo.track(eventName: "Tracked Event!")

or you can directly fetch the instance and use it from the Sugo object:

Sugo.mainInstance().track(eventName: "Tracked Event!")

You're done! You've successfully integrated the Sugo Swift SDK into your app. To stay up to speed on important SDK releases and updates, star or watch our repository on Github.

Have any questions? Reach out to [email protected] to speak to someone smart, quickly.