Merge pull request #4 from 5AbhishekSaxena/add-readme

Add readme

CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# How to Contribute
+
+- Fork this repository - [How to fork a repository](https://services.github.com/on-demand/intro-to-github/create-pull-request)
+- Clone the forked repository into local space
+- Find [an issue](https://github.com/5AbhishekSaxena/Toaster-Android/issues) that you could resolve or create a one, once approved starting working on it.
+- Create a new branch with the update `(format dev/{feature})` and make a pull request.
+- If you have a feature or bug report, feel free to [create a new issue](https://github.com/5AbhishekSaxena/Toaster-Android/issues/new/choose).

README.md

@@ -0,0 +1,68 @@
+# Toaster-Android
+
+![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/5AbhishekSaxena/Toaster-Android?include_prereleases)
+![GitHub](https://img.shields.io/github/license/5AbhishekSaxena/Toaster-Android)
+![GitHub (Pre-)Release Date](https://img.shields.io/github/release-date-pre/5AbhishekSaxena/toaster-Android)
+
+Toaster-Android is a simple open source library to customize toast messages in adnroid applications.
+It has some predefined templates for common use-cases like warning, error and success messages.
+
+ ## Download
+
+  #### Step 1
+  Add the JitPack repository to your `build.gradle(project)`.
+  ```
+ allprojects {
+	repositories {
+		...
+		maven { url 'https://jitpack.io' }
+	}
+}
+ ```
+
+  #### Step 2
+  Add the dependency to your `build.gradle(Module: app)`.
+
+  ```
+ dependencies {
+	implementation 'com.github.5AbhishekSaxena:Toaster-Android:0.1.0-beta02'
+}
+   ```
+
+ ## How to use Toaster-Android
+
+  A simple use case will look like this
+
+   ```
+  val message = "Some Message" 
+  
+  Toaster.pop(
+                this,
+                message
+            ).show()
+  ```
+
+  With a custom drawable
+
+  ```
+  val message = "Some Message" 
+  
+  Toaster.pop(
+                this,
+                message,
+                R.drawable.ic_baseline_all_inclusive_24 /* image */
+            ).show()
+  ```
+
+  ## Contributing
+  - For contributions in this repository, please read [Contribution guidelines for this project](docs/CONTRIBUTING.md) first. (Please pull the changes from this repo if you have already forked the repository and are facing conflicts)
+  - If you like the repository, please star it.
+
+  ## License
+  MIT License. See the [LICENSE](LICENSE) file for details
+
+ ## Author
+ ![GitHub followers](https://img.shields.io/github/followers/5AbhishekSaxena?style=social)
+ ![Twitter Follow](https://img.shields.io/twitter/follow/abhisheks031?style=social)
+
+ Abhishek Saxena