Skip to content

Commit 53d10e8

Browse files
committed
Update readme
1 parent 9c99f88 commit 53d10e8

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

Readme.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,10 @@ serve as a north star for this hook.
8080
Please note that this hook declares `react` and as _peer dependency_. Therefore, you must have
8181
`react` installed to use this package.
8282

83-
**Note**: This hook relies on [Intersection Observer API](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) and hence if you want to use it in a browser that doesn't
84-
support it, the onus of shipping the polyfill is on the developer.
83+
**Note**: This hook relies on
84+
[Intersection Observer API](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API)
85+
and hence if you want to use it in a browser that doesn't support it, the onus of shipping the
86+
polyfill is on the developer.
8587

8688
Please [open an issue](https://github.com/zeusdeux/use-is-in-viewport/issues/new) if these defaults
8789
cause a problem in your application.
@@ -275,5 +277,7 @@ More examples coming soon...
275277
- [x] Setup the hook to work with CRA, codesandbox and standalone react app
276278
- [x] Write the hook in a way that can be tested with Cypress
277279
- [x] Setup CI
278-
- [ ] Increase test coverage⏳
279-
- [ ] Write awesome docs!⏳
280+
- [x] Increase test coverage
281+
- [x] Write awesome docs!
282+
- [x] Deploy example app to [useisinviewport.zdx.cat/](https://useisinviewport.zdx.cat/)
283+
- [x] Document the motivation and API in the readme

0 commit comments

Comments
 (0)