Skip to content

Commit

Permalink
add Licence, doc
Browse files Browse the repository at this point in the history
Signed-off-by: Egit <[email protected]>
  • Loading branch information
esabook authored and Egit committed Dec 24, 2021
1 parent 3a3b20b commit 97e830a
Show file tree
Hide file tree
Showing 6 changed files with 65 additions and 4 deletions.
24 changes: 24 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <https://unlicense.org>
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
![](/doc/silentcrash_demo.gif)

Download sample app: [released here](https://github.com/esabook/SilentCrash/releases)

### Usage:

Root/build.gradle or Root/settings.gradle

```groovy
repositories {
// my latest development snapshot
maven { url "https://s01.oss.sonatype.org/content/repositories/snapshots" }
}
```

Root/yourApp/build.gradle
```groovy
dependencies {
// my latest development snapshot
implementation 'io.github.esabook:silentcrash:1.0.0-SNAPSHOT'
}
```

Init once at Application class or Activity class with

```kotlin
SilentCrash
.init(application)
.autoReloadAppON(true)

// optional
// add custom listener to deliver custom action
SilentCrash.getWatcher()?.setOnCrashListener(customAction)
```
3 changes: 2 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
// Top-level build file where you can add configuration options common to all sub-projects/modules.
buildscript {
ext.kotlin_version = '1.6.10'
repositories {
google()
mavenCentral()
}
dependencies {
classpath "com.android.tools.build:gradle:7.0.3"
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.6.10"
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"

// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
Expand Down
Binary file added doc/silentcrash_demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@ dependencyResolutionManagement {
repositories {
google()
mavenCentral()
jcenter() // Warning: this repository is going to shut down soon
}
}
rootProject.name = "sample"
rootProject.name = "SilentCrash"
include ':app'
include ':silentcrash'
3 changes: 2 additions & 1 deletion silentcrash/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,12 @@ android {
versionName findProperty("build.versionName")

testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
consumerProguardFiles "consumer-rules.pro"
}

buildTypes {
release {
minifyEnabled true
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
}
}
Expand Down

0 comments on commit 97e830a

Please sign in to comment.