Skip to content

Commit b50b12c

Browse files
committed
Updated README
1 parent cd8fa6d commit b50b12c

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
A HTML 5 canvas countdown clock as a React component
44

5-
[Here's a Demo](http://pughpugh.github.io/react-countdown-clock)
5+
## Demo
6+
7+
[pughpugh.github.io/react-countdown-clock](http://pughpugh.github.io/react-countdown-clock)
68

79
## Installation
810

@@ -14,10 +16,20 @@ npm install react-countdown-clock
1416

1517
```javascript
1618
<ReactCountdownClock seconds={60}
17-
color={#000}
19+
color="#000"
1820
alpha={0.9}
1921
size={300}
2022
onComplete={myCallback} />
2123
```
2224

23-
Enjoy :p
25+
## Props
26+
27+
* `seconds` to count down
28+
* `color` you'd like it to be as a hex/css colour code
29+
* `alpha` transparency for component
30+
* `size` for height and width of canvas element, in pixels.
31+
* `onComplete` callback when timer completes
32+
33+
## Bugs
34+
35+
[github.com/pughpugh/react-countdown-clock/issues](https://github.com/pughpugh/react-countdown-clock/issues)

0 commit comments

Comments
 (0)