diff --git a/README.md b/README.md index f5e594b5..e484d528 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@
- Collection of essential React Hooks. + Collection of essential React Hooks.
This is mostly port of libreact to React Hooks. @@ -24,24 +24,24 @@ ## Reference - State - - [`useToggle`](./docs/useToggle.md) - - [`useCounter`](./docs/useCounter.md) - - [`useList`](./docs/useList.md) - - [`useMap`](./docs/useMap.md) + - [`useToggle`](./docs/useToggle.md) — tracks state of a boolean. + - [`useCounter`](./docs/useCounter.md) — tracks state of a number. + - [`useList`](./docs/useList.md) — tracks state of an array. + - [`useMap`](./docs/useMap.md) — tracks state of an object. - Sensors - - [`useBattery`](./docs/useBattery.md) - - [`useGeolocation`](./docs/useGeolocation.md) - - [`useHover`](./docs/useHover.md) - - [`useIdle`](./docs/useIdle.md) - - [`useLocation`](./docs/useLocation.md) - - [`useMedia`](./docs/useMedia.md) - - [`useMediaDevices`](./docs/useMediaDevices.md) - - [`useNetwork`](./docs/useNetwork.md) - - [`useOrientation`](./docs/useOrientation.md) - - [`useSize`](./docs/useSize.md) - - [`useWindowSize`](./docs/useWindowSize.md) + - [`useBattery`](./docs/useBattery.md) — tracks device batter state. + - [`useGeolocation`](./docs/useGeolocation.md) — tracks geo location state of user's device. + - [`useHover`](./docs/useHover.md) — tracks mouse hover state of some element. + - [`useIdle`](./docs/useIdle.md) — tracks whether user is being inactive. + - [`useLocation`](./docs/useLocation.md) — tracks page navigation bar location state. + - [`useMedia`](./docs/useMedia.md) — tracks state of a CSS media query. + - [`useMediaDevices`](./docs/useMediaDevices.md) — tracks state of connected hardware devices. + - [`useNetwork`](./docs/useNetwork.md) — tracks state of user's internet connection. + - [`useOrientation`](./docs/useOrientation.md) — tracks state of device's screen orientation. + - [`useSize`](./docs/useSize.md) — tracks some HTML element's dimensions. + - [`useWindowSize`](./docs/useWindowSize.md) — tracks `Window` dimensions. - Side effects - - [`useTitle`](./docs/useTitle.md) + - [`useTitle`](./docs/useTitle.md) — sets title of the page. ## License