Kumulos Swift SDK

Kumulos provides tools to build and host backend storage for apps, send push notifications, view audience and behavior analytics, and report on adoption, engagement and performance.

Select an installation method below to get started.

Get Started with CocoaPods

Add the following line to your app's target in your Podfile:

pod 'KumulosSdkSwift', '~> 10.0.0'

Run pod install to install your dependencies.

Get Started with Carthage

Add the following line to your Cartfile:

github "Kumulos/KumulosSdkSwift" ~> 10.0.0

Run carthage update to install your dependencies then follow the Carthage integration steps to link the framework with your project.

Also link your project against:

• SystemConfiguration.framework
• MessageUI.framework (for iOS projects)
• libc++
• libz

And add the -ObjC linker flag to 'Other Linker Flags' under 'Build Settings'.

N.B. make sure to link the dynamic KSCrash.framework from the Carthage build, and not the one under Static/

Get Started with Swift Package Manager

In Xcode add a package dependency by selecting:

File > Swift Packages > Add Package Dependency

Choose this repository URL for the package repository and 9.2.5 for the version where prompted. You can then follow the integration steps below or read the full Kumulos Swift integration guide for more information.

Initializing and using the SDK

After installation, you can now import & initialize the SDK with:

import KumulosSDK

let builder = KSConfigBuilder(apiKey: "your-api-key", secretKey: "your-secret-key")
Kumulos.initialize(config: builder.build())

For more information on integrating the Swift SDK with your project, please see the Kumulos Swift integration guide.

Contributing

Pull requests are welcome for any improvements you might wish to make. If it's something big and you're not sure about it yet, we'd be happy to discuss it first. You can either file an issue or drop us a line to [email protected].

License

This project is licensed under the MIT license with portions licensed under the BSD 2-Clause license. See our LICENSE file and individual source files for more information.

Requirements

• iOS9+
• Swift5.0

Swift Version Support