Merge pull request #244 from Tapadoo/documentation-updates

Documentation updates

CHANGELOG.md

@@ -1,6 +1,24 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## 6.2.1 - 03/09/2020
+* Updated negative margin to fix overshoot on Samsung S10
+
+## 6.2.0 - 03/09/2020
+* Added the ability to enable\disable click animation
+
+## 6.1.0 - 27/06/2020
+* Readded getters for title & text TextView
+
+## 6.0.0 - 27/06/2020
+* Support custom sound
+
+## 5.1.3 - 06/06/2020
+* Bug Fixes
+
+## 5.1.2 - 16/02/2020
+* Added support for rightIcon.
+
 ## 5.1.1 - 28/01/2020
 * Minor refactoring
 
@@ -64,7 +82,7 @@ All notable changes to this project will be documented in this file.
 * Added isShowing method
 * Added additional icon setting methods
 * Added styling methods
-* added progress bar
+* Added progress bar
 
 ## 1.0.9 - 27/06/2017
 * Added Swipe to Dismiss

CONTRIBUTING.md

@@ -3,8 +3,25 @@
 ### Issues
 Make sure to search through any issues that have already been filed at https://github.com/Tapadoo/Alerter/issues before opening a new issue. 
 
+When creating an issue, please include:
+
+1. The version of the library you're using
+2. The version of Android you're testing on
+3. The device you're testing on
+4. A code snippet of how you're using the library
+5. A short description of the issue
+6. Optional - a potential solution to the issue (Remember, PRs are always welcome!)
+
+Also, please read this [article on how to write the perfect bug report](https://medium.com/pitch-perfect/how-to-write-the-perfect-bug-report-6430f5a45cd).
+
 ### Pull requests
-If you would like to contribute to the code you can do so through GitHub by forking the repository and submitting a pull request into the develop branch. When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.
+
+We welcome, and encourage PRs!
+
+If you would like to contribute to the code you can do so through GitHub by forking the repository and submitting a pull 
+request into the develop branch. When submitting code, please make every effort to follow existing conventions and style in order to keep the code as readable as possible.
+
+It's important to give motivations & use cases for new features, as we want to keep the library lean & focused.
 
 ### Checkstyles
 Make sure to run a check `./gradlew :alerter:assemble check` on the code against the quality checkers that are used by the project and fix error that get raised. See `app/build/reports/` for generated report files.

README.md

@@ -5,18 +5,18 @@ complexity of your layouts.
 
 [![Download](https://api.bintray.com/packages/tapadoo/maven/alerter/images/download.svg)](https://bintray.com/tapadoo/maven/alerter/_latestVersion) [![API](https://img.shields.io/badge/API-14%2B-orange.svg?style=flat)](https://android-arsenal.com/api?level=14) [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Alerter-blue.svg?style=flat)](https://android-arsenal.com/details/1/5302) [![Android Weekly](https://img.shields.io/badge/Android%20Weekly-%23245-blue.svg)](http://androidweekly.net/issues/issue-245)
 
-[![Header](./documentation/header.png)](https://play.google.com/store/apps/details?id=com.tapadoo.alerter_demo)
+![Header](./documentation/header.png)
 
 ## General
 
 With simplicity in mind, the Alerter employs the builder pattern to facilitate easy integration into any app.
-A customisable Alert view is dynamically added to the Decor View of the Window, overlaying all content. 
+A customisable Alert View is dynamically added to the Decor View of the Window, overlaying all content. 
 
 ## Gradle
 
 ```groovy
 dependencies {
-    implementation 'com.tapadoo.android:alerter:4.1.0'
+    implementation 'com.tapadoo.android:alerter:$current-version'
 }
 ```
 
@@ -240,14 +240,14 @@ Alerter.create(this@DemoActivity)
 
 ![Verbose Alert](./documentation/alert_with_custom_layout.gif)
 
-## Sample
+# Contributing & Reporting Issues
 
-Clone this repo and check out the `app-base` module.
+[Please read this if you're reporting an issue, or thinking of contributing!](./CONTRIBUTING.md)
 
 ## Licence
 
 See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).
 
 Copyright 2017 Tapadoo, Dublin.
 
-![Alt Text](https://tapadoo.com/wp-content/themes/tapadoo/assets/images/tapadoo_logo_dark.png)
+<img src="https://2upm2b1wdft320vzjj34rpga-wpengine.netdna-ssl.com/wp-content/uploads/2019/12/logo-tapadoo-dark.png" width="200"/>

alerter/build.gradle

@@ -14,7 +14,7 @@ apply from: rootProject.file('quality.gradle')
 
 final String GROUP_ID = "com.tapadoo.android"
 
-final String VERSION = "5.1.1"
+final String VERSION = "6.2.1"
 
 final String DESCRIPTION = "An Android Alerting Library"
 final String GITHUB_URL = "https://github.com/Tapadoo/Alerter"