Skip to content

Commit

Permalink
Merge pull request #7 from pvoznyuk/docs/readme
Browse files Browse the repository at this point in the history
v1.1.1
  • Loading branch information
pvoznyuk authored Jun 1, 2017
2 parents 4d556af + 6e9f8eb commit 1ad8d8e
Show file tree
Hide file tree
Showing 14 changed files with 34,888 additions and 32,978 deletions.
1 change: 0 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
/.*/
/.*
/reports/
/src/example/
/src/.*
/test/
/test-e2e/
Expand Down
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# react-live-clock [![npm](https://img.shields.io/npm/v/react-live-clock.svg?style=flat-square)](https://www.npmjs.com/package/react-live-clock)

[![Gitter](https://img.shields.io/gitter/room/pvoznyuk/help.svg?style=flat-square)](https://gitter.im/pvoznyuk/help)

[![CircleCI](https://img.shields.io/circleci/project/pvoznyuk/react-live-clock.svg?style=flat-square&label=nix-build)](https://circleci.com/gh/pvoznyuk/react-live-clock)
[![AppVeyor](https://img.shields.io/appveyor/ci/pvoznyuk/react-live-clock.svg?style=flat-square&label=win-build)](https://ci.appveyor.com/project/pvoznyuk/react-live-clock)
[![Coverage](https://img.shields.io/codecov/c/github/pvoznyuk/react-live-clock.svg?style=flat-square)](https://codecov.io/github/pvoznyuk/react-live-clock?branch=master)
[![Dependencies](https://img.shields.io/david/pvoznyuk/react-live-clock.svg?style=flat-square)](https://david-dm.org/pvoznyuk/react-live-clock)
[![Dev Dependencies](https://img.shields.io/david/dev/pvoznyuk/react-live-clock.svg?style=flat-square)](https://david-dm.org/pvoznyuk/react-live-clock#info=devDependencies)

Expand Down Expand Up @@ -43,13 +39,24 @@ Outputs:
<time>10:15:34</time>
```

** Shows current time for 'US/Pacific' timezine and updats every second
** Shows current time for 'US/Pacific' timezone and updats every second


### Formatting

you can use any formatting from [node-dateformat](https://github.com/felixge/node-dateformat) date library

### Properties

| Propertie | Type | Default Value | Description |
|------------|---------------------|---------------|-------------|
| `date` | timestamp or string | currrent date | Date to output, If nothing is set then it take current date. |
| `format` | string | 'HH:MM' | Formatting from [node-dateformat](https://github.com/felixge/node-dateformat) library.
| `timezone` | string | null | If timezone is set, the date is show in this timezone. You can find the list. [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), the TZ column.
| `ticking` | boolean | false | If you want the clock to be auto-updated every `inteval` seconds.
| `interval` | integer | 1000 | Auto-updating period for the clock. 1 second is a default value.
| `className`| string | null | Extra class.
| `children` | string | null | `date` can be set as a children prop.

## Development and testing

Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-live-clock",
"version": "1.1.0",
"version": "1.1.1",
"description": "React Live Clock",
"main": [
"build/react-live-clock.js",
Expand Down
25,149 changes: 8,590 additions & 16,559 deletions build/react-live-clock.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion build/react-live-clock.js.map

Large diffs are not rendered by default.

53 changes: 39 additions & 14 deletions build/react-live-clock.min.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion build/react-live-clock.min.js.map

Large diffs are not rendered by default.

Loading

0 comments on commit 1ad8d8e

Please sign in to comment.