Update README.md 📚

onesine · Jul 30, 2023 · 22e700b · 22e700b
1 parent be17b1e
commit 22e700b
Showing 1 changed file with 51 additions and 41 deletions.
diff --git a/README.md b/README.md
@@ -15,48 +15,53 @@
 </div>
 
 ## Contents
-* [Features](#features)
-* [Documentation](#documentation)
-* [Installation](#installation)
-* [Simple Usage](#simple-usage)
-* [Theming Options](#theming-options)
-* [Playground](#playground)
-* [Contributing](#contributing)
-
-##  Features
-- ✅ Theming options
-- ✅ Dark mode
-- ✅ Single Date
-- ✅ Single date use Range
-- ✅ Shortcuts
-- ✅ TypeScript support
-- ✅ Localization(i18n)
-- ✅ Date formatting
-- ✅ Disable specific dates
-- ✅ Minimum Date and Maximum Date
-- ✅ Custom shortcuts
+
+-   [Features](#features)
+-   [Documentation](#documentation)
+-   [Installation](#installation)
+-   [Simple Usage](#simple-usage)
+-   [Theming Options](#theming-options)
+-   [Playground](#playground)
+-   [Contributing](#contributing)
+
+## Features
+
+-   ✅ Theming options
+-   ✅ Dark mode
+-   ✅ Single Date
+-   ✅ Single date use Range
+-   ✅ Shortcuts
+-   ✅ TypeScript support
+-   ✅ Localization(i18n)
+-   ✅ Date formatting
+-   ✅ Disable specific dates
+-   ✅ Minimum Date and Maximum Date
+-   ✅ Custom shortcuts
 
 ## Documentation
 
 Go to [full documentation](https://react-tailwindcss-datepicker.vercel.app/)
 
 ## Installation
 
-⚠️ React Tailwindcss Datepicker uses Tailwind CSS 3 (with the [@tailwindcss/forms](https://github.com/tailwindlabs/tailwindcss-forms) plugin) & [Dayjs](https://day.js.org/en/) under the hood to work.
+⚠️ React Tailwindcss Datepicker uses Tailwind CSS 3 (with the
+[@tailwindcss/forms](https://github.com/tailwindlabs/tailwindcss-forms) plugin) &
+[Dayjs](https://day.js.org/en/) under the hood to work.
 
 ### Install via npm
 
 ```
-$ npm install react-tailwindcss-datepicker 
+$ npm install react-tailwindcss-datepicker
 ```
 
 ### Install via yarn
 
 ```
-$ yarn add react-tailwindcss-datepicker 
+$ yarn add react-tailwindcss-datepicker
 ```
 
 Make sure you have installed the peer dependencies as well with the below versions.
+
 ```
 "dayjs": "^1.11.6",
 "react": "^17.0.2 || ^18.2.0"
@@ -65,40 +70,41 @@ Make sure you have installed the peer dependencies as well with the below versio
 ## Simple Usage
 
 #### Tailwindcss Configuration
+
 Add the datepicker to your tailwind configuration using this code
 
 ```javascript
 // in your tailwind.config.js
 module.exports = {
     // ...
-    content: ["./src/**/*.{js,jsx,ts,tsx}", "./node_modules/react-tailwindcss-datepicker/dist/index.esm.js"],
+    content: [
+        "./src/**/*.{js,jsx,ts,tsx}",
+        "./node_modules/react-tailwindcss-datepicker/dist/index.esm.js"
+    ]
     // ...
-}
+};
 ```
 
 Then use react-tailwindcss-select in your app:
 
 ```jsx
-import React, {useState} from "react";
+import React, { useState } from "react";
 import Datepicker from "react-tailwindcss-datepicker";
 
 const App = () => {
     const [value, setValue] = useState({
         startDate: new Date(),
         endDate: new Date().setMonth(11)
     });
-    
-    const handleValueChange = (newValue) => {
+
+    const handleValueChange = newValue => {
         console.log("newValue:", newValue);
         setValue(newValue);
-    }
-    
+    };
+
     return (
         <div>
-            <Datepicker
-                value={value}
-                onChange={handleValueChange}
-            />
+            <Datepicker value={value} onChange={handleValueChange} />
         </div>
     );
 };
@@ -126,8 +132,8 @@ You can find the demo at [here](https://react-tailwindcss-datepicker.vercel.app/
 
 > **Info**
 >
-> 👉 To discover the other possibilities offered by this library, you can consult the [full documentation](https://react-tailwindcss-datepicker.vercel.app/).
-
+> 👉 To discover the other possibilities offered by this library, you can consult the
+> [full documentation](https://react-tailwindcss-datepicker.vercel.app/).
 
 ## PlayGround
 
@@ -146,18 +152,22 @@ Open a browser and navigate to `http://localhost:8888`
 
 ## Contributing
 
-See [CONTRIBUTING.md](https://github.com/onesine/react-tailwindcss-datepicker/blob/master/CONTRIBUTING.md)
+See
+[CONTRIBUTING.md](https://github.com/onesine/react-tailwindcss-datepicker/blob/master/CONTRIBUTING.md)
 
 ## Official Documentation repo
+
 [https://github.com/onesine/react-tailwindcss-datepicker-doc](https://github.com/onesine/react-tailwindcss-datepicker-doc)
 
 ## Thanks to
-- [Vue Tailwind Datepicker](https://vue-tailwind-datepicker.com/)
-- [React](https://reactjs.org/)
-- [Tailwind CSS](https://tailwindcss.com/)
-- [dayjs](https://day.js.org/)
+
+-   [Vue Tailwind Datepicker](https://vue-tailwind-datepicker.com/)
+-   [React](https://reactjs.org/)
+-   [Tailwind CSS](https://tailwindcss.com/)
+-   [dayjs](https://day.js.org/)
 
 I thank you in advance for your contribution to this project.
 
 ## License
+
 [MIT](LICENSE) Licensed. Copyright (c) Lewhe Onesine 2022.