✍🏻 : Changes in Docs

aromalanil · Oct 2, 2020 · 99acf18 · 99acf18
1 parent 218f80a
commit 99acf18
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -1,23 +1,23 @@
 <div align="center">
-    <h1>useCustomHooks</h1>
-    <p>A collection of custom hooks for your next React project as an npm package</p>
+    <h1>📦 useCustomHooks 📦</h1>
+    <p>npm package containing a set of custom hooks for your next React project.</p>
 	<br/>
 	<div align="center">
-  <a href="https://github.com/aromalanil/useCustomHooks/commits/master">
-    <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/aromalanil/useCustomHooks?style=for-the-badge">
-  </a>
-	<a href="https://github.com/aromalanil/useCustomHooks/issues">
-		<img alt="GitHub issues" src="https://img.shields.io/github/issues/aromalanil/useCustomHooks?style=for-the-badge">
+  <a href= "https://www.npmjs.com/package/use-custom-hooks/v/latest">
+		<img alt="npm" src="https://img.shields.io/npm/v/use-custom-hooks?style=for-the-badge">
 	</a>
 	<a href= "https://www.npmjs.com/package/use-custom-hooks/">
 		<img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/use-custom-hooks?style=for-the-badge">
 	</a>
-        <a href= "https://www.npmjs.com/package/use-custom-hooks/v/latest">
-		<img alt="npm" src="https://img.shields.io/npm/v/use-custom-hooks?style=for-the-badge">
-	</a>
 	<a href= "https://www.npmjs.com/package/use-custom-hooks/">
 		<img alt="npm Downloads/Week" src="https://img.shields.io/npm/dw/use-custom-hooks?style=for-the-badge">
 	</a>
+	<a href="https://github.com/aromalanil/useCustomHooks/issues">
+		<img alt="GitHub issues" src="https://img.shields.io/github/issues/aromalanil/useCustomHooks?style=for-the-badge">
+	</a>
+  <a href="https://github.com/aromalanil/useCustomHooks/commits/master">
+    <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/aromalanil/useCustomHooks?style=for-the-badge">
+  </a>
 	<a href="https://github.com/aromalanil/useCustomHooks/blob/master/LICENSE">
 		<img alt="GitHub License" src="https://img.shields.io/github/license/aromalanil/useCustomHooks?style=for-the-badge">
 	</a>
@@ -42,16 +42,32 @@ npm i use-custom-hooks
 # Using yarn
 yarn add use-custom-hooks
 ```
+## 📘 Available Hooks
+
+- useToggle
+- useDebounce
+- useDarkMode
+- useGeoLocation
+- useLocalStorage
+- useMousePosition
+
 ## 📄 Documentation
-To see the available hooks and how to use them, refer [Documentation](https://github.com/aromalanil/useCustomHooks/tree/master/docs)
+For documentaion, examples and other details refer [Documentation](https://github.com/aromalanil/useCustomHooks/tree/master/docs)
 
 
 ## 🤝🏻 Contributing
-Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/aromalanil/useCustomHooks/compare).
-
 
 ### Guidelines 📋
-Please read [CONTRIBUTING](https://github.com/aromalanil/useCustomHooks/blob/master/CONTRIBUTING.md) for details and the process for submitting pull requests to us.
+Please read [CONTRIBUTING](https://github.com/aromalanil/useCustomHooks/blob/master/CONTRIBUTING.md) for Code of Conduct, details and the process for submitting pull requests to us.
+
+Basic steps:
+1. [Open an issue](https://github.com/aromalanil/useCustomHooks/issues/new/choose) explaining the changes.
+2. Fork this repo.
+2. Work on the issue after you get assigned.
+3. [Open PR](https://github.com/aromalanil/useCustomHooks/compare) when the feature/fix is ready.
+4. The collaborators will review your PR and if approved will merge to the master.
+
+</br>
 
 ## Contributors ✨
 
@@ -75,9 +91,31 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 This project follows the [all-contributors](https://allcontributors.org) specification.
 Contributions of any kind are welcome!
 
+</br>
+
 ## 📜 License
 
-This project is licensed under the [MIT License](https://opensource.org/licenses/MIT) - see the [LICENSE](https://github.com/aromalanil/useCustomHooks/blob/master/LICENSE) file for details.
+```
+Copyright (c) 2020 Aromal Anil
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
 
 ## ✍🏻 Creator
 

diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,6 @@
 # Documentation
 
-## 📘 Available Hooks
+## 📗 Index
 
 - [useLocalStorage](#-uselocalstorage)
 - [useDebounce](#-usedebounce)
@@ -186,7 +186,7 @@ const Home = () => {
 ```
 
 
-# Contribution Guidlines
+# Contribution Guidelines
 Documentation for each hook should follow this template.
 
 ## Name

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "use-custom-hooks",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "A collection of Custom Hooks for React.",
   "main": "index.js",
   "scripts": {},