Skip to content

Commit f626f4f

Browse files
authored
Merge pull request #21 from xendora/updated-readme-2
Updated readme
2 parents a13963d + b6cb9a8 commit f626f4f

File tree

4 files changed

+29
-5
lines changed

4 files changed

+29
-5
lines changed

README.md

+16-3
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
11
# react-timer
2-
### WIP
3-
42
> A minimalistic yet customizable timer component!
53
4+
[Live demo](https://xendora.github.io/react-timer/examples)
5+
6+
67
<!-- [![NPM](https://img.shields.io/npm/v/react-timer.svg)](https://www.npmjs.com/package/react-timer) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) -->
78

9+
## Installation
10+
### For NPM
11+
12+
```
13+
npm install @xendora/react-timer
14+
```
15+
16+
### For Yarn
17+
18+
```
19+
yarn add @xendora/react-timer
20+
```
821

9-
## Props (--early stage--)
22+
## Props
1023
| Name | Type | Description |
1124
| ------------- | ------------- | ------------- |
1225
| children | object (required) | Define your react component here |

docs/getting-started/changelog.mdx

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,5 @@ menu: Getting Started
77

88
# Changelog
99

10-
## 0.0.1
10+
## 0.0.1
11+
* Added basic timer implementation

docs/getting-started/installation.mdx

+10
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,13 @@ menu: Getting Started
66
---
77

88
# Installation
9+
10+
### For NPM
11+
```
12+
npm install @xendora/react-timer
13+
```
14+
15+
### For Yarn
16+
```
17+
yarn add @xendora/react-timer
18+
```

example/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "react-timer-example",
33
"homepage": "https://crup.github.io/react-timer",
4-
"version": "0.0.0",
4+
"version": "0.0.1",
55
"license": "MIT",
66
"private": true,
77
"dependencies": {

0 commit comments

Comments
 (0)