react-interval-timer - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "react-interval-timer",
-  "version": "1.0.1",
-  "description": "React setInterval setTimeout Component Wrapper",
+  "version": "1.0.2",
+  "description": "React Component Wrapper for setTimeout and setInterval.",
   "main": "build/index.js",
@@ -20,2 +20,11 @@ "scripts": {
   },
+  "keywords": [
+    "react",
+    "interval",
+    "timer",
+    "timeout",
+    "repeat",
+    "setTimeout",
+    "setInterval"
+  ],
   "homepage": "",
@@ -22,0 +31,0 @@ "license": "MIT",

README.md

 # React Interval Timer
 
 [![Build Status](https://travis-ci.org/m-ueta/react-interval-timer.svg?branch=master)](https://travis-ci.org/m-ueta/react-interval-timer)
+[![MIT License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/m-ueta/react-interval-timer/blob/master/LICENCE)
 
-React Wrapper for setInterval 
+React Component Wrapper for setTimeout and setInterval.
+
+
+```sh
+npm install --save react-interval-timer
+```
+
+
+## Usage examples
+```js
+import IntervalTimer from 'react-interval-timer';
+
+class App extends React.Component {
+
+    render() {
+        return (
+            <div>
+                <IntervalTimer
+                    timeout={1000}
+                    callback={()=>{console.log("Your function")}}
+                    enabled={true}
+                    repeat={true}
+                />
+            </div>
+        )
+    }
+}
+
+export default App;
+```
+
+## Run the example app
+```sh
+git clone https://github.com/m-ueta/react-interval-timer.git
+cd react-interval-timer
+npm install
+npm start
+```
+then open http://localhost:3000
+
+
+## Options
+
+### Props
+```js
+IntervalTimer.propTypes = {
+    timeout: PropTypes.number,
+    enabled: PropTypes.bool,
+    callback: PropTypes.func,
+    repeat: PropTypes.bool
+};
+IntervalTimer.defaultProps = {
+    timeout: 1000,
+    enabled: false,
+    callback: () => {
+        console.log("You need set your callback function for IntervalTimer")
+    },
+    repeat: true
+};
+```
+
+#### timeout
+setTimeout setInterval time
+
+#### callback
+callback function
+
+#### enabled
+Switch timer  enable or disable
+
+#### repeat
+switch using setInterval or setTimeout
+
+
+
+# License
+MIT

No alert changes

Improved metrics

Total package byte prevSize

317479

increased by0.4%

Number of lines in readme file

83

increased by1283.33%

Worsened metrics

Number of package files

6

decreased by-14.29%

No dependency changes