Skip to content

Commit 95e4d58

Browse files
committed
update readme file and package.json with v1.1.4
1 parent 016769d commit 95e4d58

File tree

2 files changed

+17
-12
lines changed

2 files changed

+17
-12
lines changed

package.json

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "react-timer-hook",
3-
"version": "1.1.3",
4-
"description": "React timer hook is a custom react hook built to handle timers and count down logic in your react component.",
3+
"version": "1.1.4",
4+
"description": "React timer hook is a custom react hook built to handle timers, stopwatch and timer logic and state in your react component.",
55
"main": "dist/index.js",
66
"scripts": {
77
"build:dev": "webpack && webpack-dev-server",
@@ -13,11 +13,16 @@
1313
},
1414
"keywords": [
1515
"react",
16+
"react-hook",
17+
"react-hooks",
1618
"timer",
17-
"hook",
18-
"component",
19-
"hooks",
20-
"countdown"
19+
"countdown",
20+
"time",
21+
"clock",
22+
"useTimer",
23+
"useStopwatch",
24+
"useTime",
25+
"react-native"
2126
],
2227
"author": "amrlabib",
2328
"license": "ISC",

readme.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## react-timer-hook
22

3-
React timer hook is a custom [react hook](https://reactjs.org/docs/hooks-intro.html), built to handle time related logic in your react component:
3+
React timer hook is a custom [react hook](https://reactjs.org/docs/hooks-intro.html), built to handle timers(countdown), stopwatch, and time logic and state in your react component.
44

5-
1. Timers (countdown timer) `useTimer`
6-
2. Stopwatch (count up timer) `useStopwatch`
7-
3. Time (return current time) `useTime`
5+
1. `useTimer`: Timers (countdown timer)
6+
2. `useStopwatch`: Stopwatch (count up timer)
7+
3. `useTime`: Time (return current time)
88

99

1010
#### Note:
@@ -147,7 +147,7 @@ export default function App() {
147147
| minutes | number | minutes value |
148148
| hours | number | hours value |
149149
| days | number | days value |
150-
| start | function | function to be called to start stopwatch |
150+
| start | function | function to be called to start/resume stopwatch |
151151
| pause | function | function to be called to pause stopwatch |
152152
| reset | function | function to be called to reset stopwatch to 0:0:0:0 |
153153

@@ -211,4 +211,4 @@ export default function App() {
211211

212212
### Deprecation Warning:
213213

214-
Starting from `v1.1.0` and above default export `useTimer` is deprecated, your old code will still work but it is better to start using named exports `{ useTimer, useStopwatch }`
214+
Starting from `v1.1.0` and above default export `useTimer` is deprecated, your old code will still work but it is better to start using named exports `{ useTimer, useStopwatch, useTime }`

0 commit comments

Comments
 (0)