Build Status Version Carthage compatible Slack Status

Version 5.0.0-beta.1

Introduction

HockeySDK-Mac implements support for using HockeyApp in your Mac applications.

The following feature is currently supported:

  1. Collect crash reports: If you app crashes, a crash log with the same format as from the Apple Crash Reporter is written to the device’s storage. If the user starts the app again, he is asked to submit the crash report to HockeyApp. This works for both beta and live apps, i.e., those submitted to the App Store!

  2. User Metrics: Understand user behavior to improve your app. Track usage through daily and monthly active users, monitor crash impacted users, as well as customer engagement through session count. You can now track Custom Events in your app, understand user actions and see the aggregates on the HockeyApp portal.

  3. Feedback: Collect feedback from your users from within your app and communicate directly with them using the HockeyApp backend.

  4. Add analytics to Sparkle: If you are using Sparkle to provide app-updates (HockeyApp also supports Sparkle feeds for beta distribution) the SDK contains helpers to add some analytics data to each Sparkle request.

1. Setup

It is super easy to use HockeyApp in your macOS app. Have a look at our documentation and onboard your app within minutes.

2. Documentation

Please visit our landing page as a starting point for all of our documentation.

Please check out our changelog, as well as our troubleshooting section.

3. Contributing

We’re looking forward to your contributions via pull requests.

3.1 Development environment

  • A Mac running the latest version of macOS.
  • The latest Xcode from the Mac App Store.
  • Jazzy to generate documentation.
  • CocoaPods to test integration with CocoaPods.
  • Carthage to test integration with Carthage.

3.2 Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

3.3 Contributor License

You must sign a Contributor License Agreement before submitting your pull request. To complete the Contributor License Agreement (CLA), you will need to submit a request via the form and then electronically sign the CLA when you receive the email containing the link to the document. You need to sign the CLA only once to cover submission to any Microsoft OSS project.

4. Contact

If you have further questions or are running into trouble that cannot be resolved by any of the steps in our troubleshooting section, feel free to open an issue here, contact us at support@hockeyapp.net or join our Slack.