Create README.md

Author: akndmr

README.md

@@ -0,0 +1,88 @@
+# PinLayout ⚬⚬⚬⚬
+Android PinLayout for auth screens.
+
+<img width="193" alt="Screen Shot 2022-12-04 at 03 42 09" src="https://user-images.githubusercontent.com/15641747/205468291-4aee9855-df47-4887-8ced-b075baf61931.png">
+
+
+![Language](https://img.shields.io/github/languages/top/akndmr/PinLayout) 
+![GitHub issues](https://img.shields.io/github/issues/akndmr/PinLayout)
+![GitHub Repo stars](https://img.shields.io/github/stars/akndmr/PinLayout?style=social)
+![JitPack](https://img.shields.io/jitpack/version/com.github.akndmr/PinLayout)
+## Installation
+
+Step 1. Add the JitPack repository to your build file
+
+```gradle
+  allprojects {
+		repositories {
+			...
+			maven { url 'https://jitpack.io' }
+		}
+	}
+```
+
+Step 2. Add the dependency
+
+```gradle
+  dependencies {
+	    implementation 'com.github.akndmr:PinLayout:LatestVersion'
+	}
+```
+    
+
+## Demo
+https://user-images.githubusercontent.com/15641747/205468372-c6af52be-6ebe-4691-b235-d2252ec1cb2a.mov
+
+
+
+## Usage
+
+#### Show a AirySnackbar
+
+You can add pin by providing a data source like keyboard.
+```kotlin
+ addPinCode(number)
+```
+
+You can add whole pin from a clipboard.
+```kotlin
+ pasteFullPinCode()
+```
+
+
+You can remove the last added pin.
+```kotlin
+ removePinCode()
+```
+
+You can clear PinLayout completely.
+```kotlin
+ clearPinCode()
+```
+
+You can register a listener for pin change and pin complete events.
+```kotlin
+ setOnPinChangeListener(
+                    onPinChange = { pin ->
+                        //todo
+                    },
+                    onPinComplete = {
+                        //todo
+                    }
+                )
+```
+
+You can customize PinLayout with custom attributes. 
+```kotlin
+ app:pin_count="8"
+ app:pin_view_active_color="@color/bg3"
+ app:pin_view_gap="12dp"
+ app:pin_view_radius="16dp"
+ app:pin_view_extra_gap="@dimen/margin_32"
+ app:pin_view_extra_gap_index="3"
+```
+
+## Roadmap
+
+- Add custom animation support.
+