readme update
parent
009b7241da
commit
e9528df03b
13
README.md
13
README.md
|
@ -1,6 +1,10 @@
|
||||||
# react-hooks
|
# 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
|
```bash
|
||||||
// with npm
|
// 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
|
yarn add @flare/react-hooks --registry https://lab.code-rove.com/public-node-registry
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## How to use the package
|
||||||
|
|
||||||
```jsx
|
```jsx
|
||||||
import { useWindowSize, useLink, useTitle } from "@flare/react-hooks";
|
import { useWindowSize, useLink, useTitle } from "@flare/react-hooks";
|
||||||
```
|
```
|
||||||
|
|
||||||
**1.0.0**
|
## Changelog
|
||||||
This version includes the initial version of react-hooks component.
|
|
||||||
|
**1.0.0** - This version includes the initial version of react-hooks package.
|
||||||
|
|
Loading…
Reference in New Issue