]> git.immae.eu Git - github/fretlink/time-picker.git/blobdiff - README.md
lint
[github/fretlink/time-picker.git] / README.md
index d2dcc3cab07bcf0eb58b6566a965e595d680cf9c..60e5ab035cfb610e8dd581304700b3e5fa3439a1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,6 +2,31 @@
 
 React TimePicker
 
+[![NPM version][npm-image]][npm-url]
+[![build status][travis-image]][travis-url]
+[![Test coverage][coveralls-image]][coveralls-url]
+[![gemnasium deps][gemnasium-image]][gemnasium-url]
+[![node version][node-image]][node-url]
+[![npm download][download-image]][download-url]
+
+[npm-image]: http://img.shields.io/npm/v/rc-time-picker.svg?style=flat-square
+[npm-url]: http://npmjs.org/package/rc-time-picker
+[travis-image]: https://img.shields.io/travis/react-component/time-picker.svg?style=flat-square
+[travis-url]: https://travis-ci.org/react-component/time-picker
+[coveralls-image]: https://img.shields.io/coveralls/react-component/time-picker.svg?style=flat-square
+[coveralls-url]: https://coveralls.io/r/react-component/time-picker?branch=master
+[gemnasium-image]: http://img.shields.io/gemnasium/react-component/time-picker.svg?style=flat-square
+[gemnasium-url]: https://gemnasium.com/react-component/time-picker
+[node-image]: https://img.shields.io/badge/node.js-%3E=_4.0.0-green.svg?style=flat-square
+[node-url]: http://nodejs.org/download/
+[download-image]: https://img.shields.io/npm/dm/rc-time-picker.svg?style=flat-square
+[download-url]: https://npmjs.org/package/rc-time-picker
+
+example
+--------
+
+http://react-component.github.io/time-picker/
+
 install
 -------
 
@@ -37,9 +62,9 @@ API
 | showHour       | Boolean                    | whether show hour                             |                                                                                            |
 | showSecond     | Boolean                    | whether show second                           |                                                                                            |
 | formatter      | String|GregorianCalendarFormatter |                                        |                                                                                            |
-| hourOptions    | Array<String>              | hour options                                  |                                                                                            |
-| minuteOptions  | Array<String>              | minute options                                |                                                                                            |
-| secondOptions  | Array<String>              | second options                                |                                                                                            |
+| hourOptions    | Array<Number>              | hour options                                  |                                                                                            |
+| minuteOptions  | Array<Number>              | minute options                                |                                                                                            |
+| secondOptions  | Array<Number>              | second options                                |                                                                                            |
 | onChange       | Function                   | null                                          | called when select a different value                                                       |
 | placement      | String                     | bottomLeft                                    | one of ['left','right','top','bottom', 'topLeft', 'topRight', 'bottomLeft', 'bottomRight'] |
 | transitionName | String                     | ''                                            |                                                                                            |