Skip to content

Commit f3e882b

Browse files
committed
docs(*): more transparency about supported environments
1 parent 46bfac1 commit f3e882b

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,20 @@ By default the library ships with Typescript definitions, so there is no need to
3535

3636
For detection of some resize events the `ResizeObserver` API is used internally which is not supported in some browsers. Please make sure to implement a polyfill on your own in case its required for your application.
3737

38+
## Supported Environments
39+
40+
### Browsers
41+
42+
The goal is to support the most recent versions of all major browsers (Internet Explorer, Edge, Safari, Chrome and Firefox).
43+
44+
We try to be downward compatible with older browsers when possible to at least not throw errors, but older versions will not be test at all.
45+
46+
In case you have specific requirements, please fill an issue or create a PR so we can discuss about them.
47+
48+
### NodeJS
49+
50+
The project aims to support recent releases of v8 and v10 of NodeJS.
51+
3852
## Documentation
3953

4054
### API

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@
2121
"bugs": {
2222
"url": "https://github.com/garthenweb/react-viewport-utils/issues"
2323
},
24+
"engines": {
25+
"node": "^8.9.0 || ^10.13.0"
26+
},
2427
"author": "Jannick Garthen <jannick.garthen@gmail.com>",
2528
"keywords": [
2629
"react",

0 commit comments

Comments
 (0)