Merge remote-tracking branch 'origin/master'

Author: ceribe

README.md

@@ -1,13 +1,9 @@
-# How to prepare a new library:
-1. Rename module
-2. Rename package
-3. Find all other instances of "ceribelibname" (Ctrl + F) and rename them
-4. Prepare README.md and remove this list
-
-Here add jitpack badge
+[![](https://jitpack.io/v/ceribe/compose-overflow-menu.svg)](https://jitpack.io/#ceribe/compose-overflow-menu)
 
 # Overflow Menu
-Here short description and screenshots/gifs
+Android library for Jetpack Compose providing an Overflow Menu via fast and easy to use DSL.
+
+<img src="art/Sample1.gif" width="250"/>
 
 # How to add to project
 ### Step 1. Add the JitPack repository to your build file
@@ -23,12 +19,39 @@ Add it in your root build.gradle at the end of repositories:
 ### Step 2. Add the dependency
 ```gradle
   dependencies {
-       Here place dependency provided by jitpack
+       implementation 'com.github.ceribe:compose-overflow-menu:1.0'
   }
 ```
 
 # How to use
-Here add some sample code
+```kotlin 
+OverflowMenu {
+    shownIconsCount = 2 //How many icons will be shown on top app bar, rest will be hidden under overflow icon
+    icons {
+        icon {
+            imageVector = Icons.Filled.Edit
+            onClick = { context.toast("First Icon Clicked") }
+        }
+        icon {
+            imageVector = Icons.Filled.Delete
+            onClick = { context.toast("Second Icon Clicked") }
+        }
+        icon {
+            label = "Third Example"
+            onClick = { context.toast("Third Icon Clicked") }
+        }
+    }
+    //Default values for icons. If icon does not have some parameter set it will use the one from defaults
+    defaults {
+        tint = Color.Red
+    }
+    //Parameters for overflow icon
+    overflowIcon {
+        tint = Color.Yellow
+    }
+}
+```
+For more in examples check [here](https://github.com/ceribe/compose-overflow-menu/blob/master/sample/src/main/java/com/ceribe/compose/sample/MainActivity.kt)
 
 # License
 ```