mirror of
https://github.com/dzeiocom/crashhandler.git
synced 2025-04-23 19:32:12 +00:00
65 lines
1.7 KiB
Markdown
65 lines
1.7 KiB
Markdown
<p align="center">
|
|
<img alt="Dzeio Charts logo" width="30%" src="sample/src/main/ic_launcher-playstore.png">
|
|
</p>
|
|
|
|
# Crash Handler
|
|
|
|
Lightweight & customizable crash android crash handler library
|
|
|
|
## Install
|
|
|
|
- Add Jitpack.io to your `settings.gradle` file `maven { url 'https://jitpack.io' }`
|
|
|
|
Add to you dependencies (check the latest release for the version):
|
|
- (Gradle Kotlin DSL) Add `implementation("com.dzeio:crashhandler:1.0.2")`
|
|
- (Gradle Groovy DSL) Add `implementation "com.dzeio:crashhandler:1.0.2" `
|
|
|
|
## Usage
|
|
|
|
_note: full featured example in the `sample` app_
|
|
|
|
Create and add this to your Application.{kt,java}
|
|
|
|
```kotlin
|
|
CrashHandler.Builder()
|
|
// need the application context to run
|
|
.withContext(this)
|
|
// every other items below are optionnal
|
|
// define a custom activity to use
|
|
.withActivity(ErrorActivity::class.java)
|
|
|
|
// define the preferenceManager to be able to handle crash in a custom Activity and to have the previous crash date in the logs
|
|
.withPrefs(prefs)
|
|
.withPrefsKey("com.dzeio.crashhandler.key")
|
|
|
|
// a Prefix to add at the beggining the crash message
|
|
.withPrefix("Pouet :D")
|
|
|
|
// a Suffic to add at the end of the crash message
|
|
.withSuffix("WHYYYYY")
|
|
|
|
// build & start the module
|
|
.build().setup()
|
|
```
|
|
|
|
## Build
|
|
|
|
- Install Android Studio
|
|
- Build the app
|
|
- it will be running on your emulator/device
|
|
- test it!
|
|
|
|
## Contributing
|
|
|
|
See [CONTRIBUTING.md](https://github.com/dzeiocom/crashhandler/blob/master/CONTRIBUTING.md)
|
|
|
|
TL::DR
|
|
|
|
- Fork
|
|
- Commit your changes
|
|
- Pull Request on this Repository
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License. A copy of the license is available at [LICENSE.md](https://github.com/dzeiocom/crashhandler/blob/master/LICENSE.md)
|