Skip to content
This repository has been archived by the owner on Aug 2, 2023. It is now read-only.

Latest commit

 

History

History
56 lines (38 loc) · 2.54 KB

README.md

File metadata and controls

56 lines (38 loc) · 2.54 KB
Raw

Introduction

This is a demo project, how to integrate the HockeyApp Android SDK into your app.

This document contains the following sections:

  1. Overview
  2. Getting Started
  3. Contributing
  4. Code of Conduct
  5. Contributor License
  6. Contact

1. Overview

This project can be used as a starting point for your Android app or sample how to integrate the HockeyApp Android SDK into your app. It currently focuses on the following aspects:

  • crash reporting
  • in-app updates
  • user feebdack

2. Getting Started

To run this project there are some steps to perform, because we can not share the credentials to the app:

  1. Clone the project.
  2. Create a demo app in your HockeyApp account.
  3. Open the app/gradle.properties file and replace the hockeyapp_app_id and hockeyapp_app_secret keys with the app id and app secret from your app in HockeyApp.
  4. Sync your Gradle settings and build the app.

Please make sure to never commit your changes to the repository.

3. Contributing

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

Development environment

3.1 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 [email protected] with any additional questions or comments.

3.2 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 here, feel free to open a GitHub issue here or contact us at [email protected]