Update README.md

pavi2410 · Dec 14, 2021 · 903ef7c · 903ef7c
1 parent db00560
commit 903ef7c
Showing 1 changed file with 29 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,30 @@
 useCompose
+---
+
+React inspired hooks for Compose
+
+![carbon](https://user-images.githubusercontent.com/28837746/146000979-428e294d-425c-448b-a5e4-66110ab81100.png)
+
+### Installation
+
+Step 1. Add the JitPack repository to your build file 
+
+Add it in your root build.gradle at the end of repositories:
+```gradle
+allprojects {
+  repositories {
+    ...
+    maven { url 'https://jitpack.io' }
+  }
+}
+```
+
+Step 2. Add the dependency
+```gradle
+dependencies {
+  implementation 'com.github.pavi2410:useCompose:1.0.0'
+}
+```
+
+### Help Wanted
+I want your help in making this library extensive such that this covers many of the commonly used hooks. Also, I want your help in building a KMP friendly library.