added instructions to readme

jitunayak · Nov 27, 2022 · ad17531 · ad17531
1 parent 152467d
commit ad17531
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/src/components/README.md b/src/components/README.md
@@ -1,7 +1,27 @@
-## 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" },

diff --git a/src/components/package.json b/src/components/package.json
@@ -1,6 +1,6 @@
 {
   "name": "slick-react-multiselect-dropdown",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "slick design lightweight multiple selection dropdown component",
   "main": "MultiSelect.tsx",
   "scripts": {