feat: update params order for withViewport

Author: JB1905

.gitignore

@@ -3,3 +3,4 @@ node_modules
 yarn-error.log
 .rpt2_cache
 coverage
+lib

CHANGELOG.md

@@ -1,38 +1,61 @@
 # react-viewport-hooks Changelog
 
+## 1.4.0 (2020-05-25)
+
+#### Breaking Changes
+
+- updated `withViewport` params order
+
 ## 1.3.0 (2020-04-14)
+
 #### Breaking Changes
+
 - removed default values for `vw` & `vh`
 
 #### New Feature
+
 - added options to set default values for `vw` & `vh`
 
 ## 1.2.2 (2020-02-23)
+
 #### Bug Fix
+
 - fixed `WrappedComponent` type
 
 #### Repository Changes
+
 - added tests
 
 ## 1.2.0 beta 2 / 1.2.0 beta 3 / 1.2.0 / 1.2.1 (2020-02-11)
+
 #### Bug Fix
+
 - added missing `options` prop to HOC
 
 ## 1.2.0 beta 1 (2020-02-11)
+
 #### New Feature
+
 - added `withViewport` HOC
 
 ## 1.1.2 beta 1 / 1.1.2 (2020-02-01)
+
 #### Improvement
+
 - added event listener cleanup after resize
 
 ## 1.1.0 / 1.1.1 (2019-08-13)
+
 #### Bug Fix
+
 - fixed `window id undefined` error in SSR apps
 
 #### Repository Changes
+
 - added ES module
 
 ## 1.0.1 / 1.0.2 (2019-08-05)
+
 #### New Feature
+
 - added `useViewport` hook

README.md

@@ -4,35 +4,44 @@
 [![NPM downloads](http://img.shields.io/npm/dm/react-viewport-hooks.svg?style=flat-square)](https://www.npmjs.com/package/react-viewport-hooks)
 
 ## About
+
 Get real viewport width & height
 
 ## How to Install
+
 First, install the library in your project by npm:
+
 ```sh
 $ npm install react-viewport-hooks
 ```
 
 Or Yarn:
+
 ```sh
 $ yarn add react-viewport-hooks
 ```
 
 ## Getting Started
+
 #### Options
-Name | Type | Default | Description
--|-|-|-
-**updateOnResize** | boolean | `true` | Update sizes on window resize
-**defaultVW** | number | `undefined` | Fallback for default `vw` value
-**defaultVH** | number | `undefined` | Fallback for default `vh` value
+
+| Name               | Type    | Default     | Description                     |
+| ------------------ | ------- | ----------- | ------------------------------- |
+| **updateOnResize** | boolean | `true`      | Update sizes on window resize   |
+| **defaultVW**      | number  | `undefined` | Fallback for default `vw` value |
+| **defaultVH**      | number  | `undefined` | Fallback for default `vh` value |
 
 #### Returned Values
-Name | Type | Description
--|-|-
-**vw** | number | Window viewport width
-**vh** | number | Window viewport height
+
+| Name   | Type   | Description            |
+| ------ | ------ | ---------------------- |
+| **vw** | number | Window viewport width  |
+| **vh** | number | Window viewport height |
 
 #### Example
+
 **`useViewport` hook:**
+
 ```js
 import React from 'react';
 import { useViewport } from 'react-viewport-hooks';
@@ -43,15 +52,14 @@ const App = () => {
   document.documentElement.style.setProperty('--vw', `${vw}px`);
   document.documentElement.style.setProperty('--vh', `${vh}px`);
 
-  return (
-    <h1>Hello Viewport!</h1>
-  );
-}
+  return <h1>Hello Viewport!</h1>;
+};
 
 export default App;
 ```
 
 **`withViewport` HOC:**
+
 ```js
 import React from 'react';
 import { withViewport } from 'react-viewport-hooks';
@@ -60,13 +68,12 @@ const App = ({ vw, vh }) => {
   document.documentElement.style.setProperty('--vw', `${vw}px`);
   document.documentElement.style.setProperty('--vh', `${vh}px`);
 
-  return (
-    <h1>Hello Viewport!</h1>
-  );
+  return <h1>Hello Viewport!</h1>;
 };
 
-export default withViewport(App, /* object with options (if needed) */);
+export default withViewport(/* object with options (if needed) */)(App);
 ```
 
 ## License
+
 This project is licensed under the MIT License © 2019-present Jakub Biesiada