From e65321be647a50ae8a5cd7d33ec94f7ba2b5b004 Mon Sep 17 00:00:00 2001
From: jitunayak <jitunayak715@gmail.com>
Date: Mon, 28 Nov 2022 11:24:02 +0530
Subject: [PATCH] updated readme for homepage

---
 README.md | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 64 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6a9a147..1fd5d45 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,64 @@
-### slick-react-multiselect-dropdown
+# Slick React Multiselect Dropdown
+
+A very `lightweight` and simple multiple selection dropdown component with `search`
+
+[![NPM](https://img.shields.io/npm/v/slick-react-multiselect-dropdown.svg)](https://npm.im/slick-react-multiselect-dropdown)
+[![gzip](https://badgen.net/bundlephobia/minzip/slick-react-multiselect-dropdown@latest)](https://bundlephobia.com/result?p=slick-react-multiselect-dropdownt@latest)
+
+!["demo snapshot"](https://github.com/jitunayak/slick-react-multiselect-dropdown/blob/main/public/snapshot1.jpeg?raw=true)
+
+## ✨ Features
+
+- 🕶 Zero Dependency
+- 🍃 Lightweight (<5KB)
+- ✌ Written w/ TypeScript
+
+## 🔧 Installation
+
+```bash
+npm i slick-react-multiselect-dropdown    # npm
+yarn add slick-react-multiselect-dropdown # yarn
+```
+
+## 📦 Example
+
+```ts
+ const listItems = [
+    { label: "Apple 🍎", key: "apple" },
+    { label: "Unicorn 🦄", key: "unicorn" },
+    { label: "Burger 🍔", key: "burder" },
+    { label: "Cheers 🥂", key: "cheers" },
+  ];
+
+  const [selectedItem, setSelectedItem] = useState([]);
+
+   <MultiSelect
+        placeholder="Select from list"
+        list={listItems}
+        selectedItems={selectedItem}
+        setSelectedItems={setSelectedItem}
+    />
+```
+
+## 💄 Themable
+
+color values for selected Items could be in all css accepted formats. such as `#cece` `rgb(254 242 242)` `green`
+
+```ts
+
+  const colorSelectedItem = {
+    { border: "red", background: "rgb(254 242 242)" }
+  }
+
+   <MultiSelect
+        placeholder="Select from list"
+        list= {listItems}
+        selectedItems= {selectedItem}
+        setSelectedItems= {setSelectedItem}
+        colorSelectedItem= {colorSelectedItem}
+    />
+```
+
+## Result
+
+!["demo snapshot"](https://github.com/jitunayak/slick-react-multiselect-dropdown/blob/main/public/snapshot2.jpeg?raw=true)