use-resize-observer - npm Package Compare versions

Comparing version 2.0.1 to 3.0.0

CHANGELOG.md

 # CHANGELOG
 
+## 3.0.0
+
+- [BREAKING] Requires React 16.8.0 or above, which is the first non-alpha release
+  that includes hooks
+
 ## 2.0.1
@@ -4,0 +9,0 @@

package.json

 {
   "name": "use-resize-observer",
-  "version": "2.0.1",
+  "version": "3.0.0",
   "main": "dist/bundle.cjs.js",
   "module": "dist/bundle.esm.js",
   "repository": "[e-mail]:ZeeCoder/use-resize-observer.git",
-  "description": "A React hook to use a Resize Observer",
+  "description": "A React hook that allows you to use a ResizeObserver to measure an element's size.",
   "author": "Viktor Hubert <[e-mail]>",
@@ -31,4 +31,4 @@ "license": "MIT",
   "peerDependencies": {
-    "react": "16.7.0-alpha.2",
-    "react-dom": "16.7.0-alpha.2"
+    "react": ">=16.8.0",
+    "react-dom": ">=16.8.0"
   },
@@ -48,10 +48,7 @@ "devDependencies": {
     "prettier": "^1.14.3",
-    "react": "16.7.0-alpha.2",
-    "react-dom": "16.7.0-alpha.2",
+    "react": "^16.8.1",
+    "react-dom": "^16.8.1",
     "rollup": "^0.66.6",
     "rollup-plugin-babel": "^4.0.3"
-  },
-  "publishConfig": {
-    "access": "public"
   }
 }

README.md

 # use-resize-observer
 
-A React hook to use a Resize Observer.
+A React hook that allows you to use a ResizeObserver to measure an element's size.
 
-[![npm version](https://badge.fury.io/js/%40zeecoder%2Fuse-resize-observer.svg)](https://npmjs.com/package/@zeecoder/use-resize-observer)
+[![npm version](https://badge.fury.io/js/use-resize-observer.svg)](https://npmjs.com/package/use-resize-observer)
 [![build](https://travis-ci.org/ZeeCoder/use-resize-observer.svg?branch=master)](https://travis-ci.org/ZeeCoder/use-resize-observer)
 
+## Install
+
+```
+yarn add use-resize-observer
+# or
+npm install --save use-resize-observer
+```
+
 ## Usage
@@ -25,4 +33,14 @@
 
+## Notes
+
+- Uses [resize-observer-polyfill](https://github.com/que-etc/resize-observer-polyfill)
+  internally, which falls back to the native ResizeObserver, if available.
+
+## Related
+
+- [@zeecoder/react-resize-observer](https://github.com/ZeeCoder/react-resize-observer)
+- [@zeecoder/container-query](https://github.com/ZeeCoder/container-query)
+
 ## License
 
 MIT

No alert changes

Improved metrics

Total package byte prevSize

7849

increased by7.49%

Number of lines in readme file

46

increased by64.29%

No dependency changes