archive-gh-me/react-use
1
0
Fork 0
mirror of https://github.com/streamich/react-use.git synced 2026-01-25 14:17:16 +00:00
Code Issues Projects Releases Wiki Activity

docs: ✏️ improve README formatting

Browse Source
This commit is contained in:
streamich 2018-10-27 12:38:18 +02:00
parent f7ecdaf71d
commit 9501d1841f
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -11,12 +11,15 @@
<br />
</h1>
<sup>
<br />
<br />
Collection of essential <a href="https://reactjs.org/docs/hooks-intro.html">React Hooks</a>.</em>
<br />
<em>This is mostly port of <a href="https://github.com/streamich/libreact"><code>libreact</code></a> to React Hooks.</em>
</sub>
<br />
<br />
<br />
</div>
@ -28,6 +31,8 @@
- [`useCounter`](./docs/useCounter.md) &mdash; tracks state of a number.
- [`useList`](./docs/useList.md) &mdash; tracks state of an array.
- [`useMap`](./docs/useMap.md) &mdash; tracks state of an object.
<br/>
<br/>
- Sensors
- [`useBattery`](./docs/useBattery.md) &mdash; tracks device batter state.
- [`useGeolocation`](./docs/useGeolocation.md) &mdash; tracks geo location state of user's device.
@ -40,8 +45,12 @@
- [`useOrientation`](./docs/useOrientation.md) &mdash; tracks state of device's screen orientation.
- [`useSize`](./docs/useSize.md) &mdash; tracks some HTML element's dimensions.
- [`useWindowSize`](./docs/useWindowSize.md) &mdash; tracks `Window` dimensions.
<br/>
<br/>
- Side effects
- [`useTitle`](./docs/useTitle.md) &mdash; sets title of the page.
<br/>
<br/>
## License