Skip to content

Commit a73f1ec

Browse files
committed
docs: ✏️ add referene for Sensors and Side-effects
1 parent 6124e4b commit a73f1ec

File tree

4 files changed

+17
-2
lines changed

4 files changed

+17
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
- [`useMap`](./docs/useMap.md) — tracks state of an object.
3838
<br/>
3939
<br/>
40-
- Sensors
40+
- [__Sensors__](./docs/Sensors.md)
4141
- [`useBattery`](./docs/useBattery.md) &mdash; tracks device batter state.
4242
- [`useGeolocation`](./docs/useGeolocation.md) &mdash; tracks geo location state of user's device.
4343
- [`useHover`](./docs/useHover.md) &mdash; tracks mouse hover state of some element.
@@ -52,7 +52,7 @@
5252
- [`useWindowSize`](./docs/useWindowSize.md) &mdash; tracks `Window` dimensions.
5353
<br/>
5454
<br/>
55-
- Side effects
55+
- [__Side-effects__](./docs/Side-effects.md)
5656
- [`useTitle`](./docs/useTitle.md) &mdash; sets title of the page.
5757
<br/>
5858
<br/>

docs/Sensors.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sensors
2+
3+
*"Sensor Hooks"* listen to changes in some interface and force your components
4+
to be re-rendered with the new state, up-to-date state.

docs/Side-effects.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Side-effects
2+
3+
*"Side-effect Hooks"* allow your app trigger various side-effects using browser's API.

package.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@
1717
},
1818
"author": "@streamich",
1919
"license": "Unlicense",
20+
"repository": {
21+
"type": "git",
22+
"url": "https://github.com/streamich/react-use.git"
23+
},
24+
"bugs": {
25+
"url": "https://github.com/streamich/react-use/issues"
26+
},
27+
"homepage": "https://github.com/streamich/react-use#readme",
2028
"dependencies": {
2129
"@types/react": "^16.4.18",
2230
"@types/react-dom": "^16.0.9",

0 commit comments

Comments
 (0)