From bfc90e399b14cda7a63c1680e1023f93d1749e78 Mon Sep 17 00:00:00 2001
From: Ahmed Khusaam <hello@khusaam.com>
Date: Sun, 6 Jun 2021 22:26:22 +0500
Subject: [PATCH] update readme

---
 README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)

diff --git a/README.md b/README.md
index e69de29..48f3aee 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,68 @@
+# thaana-keyboard
+Thaana keyboard replaces latin text to thaana unicode characters using JavaScript. 
+
+Demo: [https://thaana-keyboard.khusaam.com](https://thaana-keyboard.khusaam.com)
+
+## Installation & Usage
+
+npm
+
+```
+npm i thaana-keyboard
+```
+
+or using yarn
+
+```
+yarn add thaana-keyboard
+```
+
+or link to build file in d
+
+```
+<script src="../dist/ThaanaKeyboard.min.js"></script>
+```
+
+To start using in the default config, setup the input by adding class `thaana-keyboard` to the element
+
+```
+<input type="text"
+	class="thaana-keyboard">
+```
+
+and initiating the keyboard
+
+```
+<script>
+window.addEventListener('DOMContentLoaded' , (e) => {
+    new ThaanaKeyboard();
+});
+</script>
+```
+
+If you need to use a different class, you can specify it as the first argument. Example:
+
+```
+<script>
+window.addEventListener('DOMContentLoaded' , (e) => {
+    new ThaanaKeyboard('my-custom-thaana-class');
+});
+</script>
+```
+
+Just make sure that the same class is assigned to the input ot textarea
+
+The second argument for the class is a boolean which determines to run the class immediately. If specified `false` you much run it manually. Example:
+
+```
+<script>
+window.addEventListener('DOMContentLoaded' , (e) => {
+    const tk = new ThaanaKeyboard(
+        'my-custom-thaana-class', 
+        false
+    );
+
+    tk.run();
+});
+</script>
+```
\ No newline at end of file