Official Swift SDK for integrating Kumulos services with your mobile apps
Swift Objective-C Ruby
Latest commit 6e90193 Oct 9, 2017 @azlindsay azlindsay committed with cgwyllie Crash reporting (#6)
* Add KSCrash dependency to cartfile.
Add initial helper method to track crashes to API.

* Builder pattern for initialising the SDK correctly.
If SDK is initialised with crash tracking enabled then setup and send any pending reports.

* Bump various version numbers.

* Restore stats to 1.4.0 version.

* Kill tab.

* Fix casing and build warnings.

* Hide the tracking function from the public interface, flip the order of sending stats ping and recording crashes.

* Expose helper method for logging manual exceptions immediately.

* Update dependencies.

* Chop duplication in readme and update the initialization snippet.
Permalink
Failed to load latest commit information.
Carthage/Checkouts
KumulosSDK.xcodeproj
KumulosSDK.xcworkspace
Sources
.gitignore
.gitmodules
Cartfile
Cartfile.resolved
KSConfig.swift
KumulosSdkSwift.podspec
LICENSE
README.md

README.md

Kumulos Swift SDK Carthage compatible

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', '~> 2.0'

Run pod install to install your dependencies.

Get Started with Carthage

Add the following line to your Cartfile:

github "Kumulos/KumulosSdkSwift" ~> 2.0

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

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 support@kumulos.com.

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+
  • Swift3