diff --git a/README.md b/README.md index df7488b..1a633ff 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # react-hooks -## Install +## Introduction + +**react-hooks** is an npm package that brings together multiple react hooks useful both in the development of the ecosystem in my home lab and for the general public. + +## Package installation ```bash // with npm @@ -10,11 +14,12 @@ npm i --save @flare/react-hooks --registry https://lab.code-rove.com/public-node yarn add @flare/react-hooks --registry https://lab.code-rove.com/public-node-registry ``` -## Usage +## How to use the package ```jsx import { useWindowSize, useLink, useTitle } from "@flare/react-hooks"; ``` -**1.0.0** -This version includes the initial version of react-hooks component. +## Changelog + +**1.0.0** - This version includes the initial version of react-hooks package.