Skip to content

Commit

Permalink
Update Changelog and README
Browse files Browse the repository at this point in the history
I forgot to mention that I will be experimenting with deprecating
showWidgetOnAddonClick in a future release.
  • Loading branch information
mrhota committed Jan 3, 2016
1 parent bde2ba1 commit 41b8d8c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 23 deletions.
5 changes: 2 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,14 @@ sort of conforms to Semantic Versioning. Since we're still pre-1.0,
it's like the Wild West up in here!

## Unreleased

### Added (not started)
- Still planning out how to include i18n data and functionality.

### Deprecated (not started)
- Incorrect usage of the word "meridian" will be deprecated. It should
be "meridiem".


- `showWidgetOnAddonClick`'s current behavior is not intuitive. Clicking
the input addon should _toggle_ the widget instead of showing it.

## 0.5.2 - 2016-01-02
### Added
Expand Down
36 changes: 16 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@
Timepicker for Twitter Bootstrap
=======

Timepicker for Twitter Bootstrap [![Build Status](https://travis-ci.org/jdewit/bootstrap-timepicker.svg?branch=gh-pages)](https://travis-ci.org/jdewit/bootstrap-timepicker)
------------------------------------
[![Build Status](https://travis-ci.org/jdewit/bootstrap-timepicker.svg?branch=gh-pages)](https://travis-ci.org/jdewit/bootstrap-timepicker)

A simple timepicker component for Twitter Bootstrap.

Status
======
This project is alive again. While the maintainers clean things up, it would be best if you download a release
archive from the Releases tab instead of using the HEAD code. The maintainers will be preparing new releases
to take care of longstanding issues. Otherwise, fork away or use some of the other excellent timepickers available.
Please take a look at the `CHANGELOG.md` and the issues tab for issues we're
working on and their relative priorities.

Installation
============

This project is registered as a <a href="http://bower.io">Bower</a> package, and can be installed with the following command:
This project is registered as a <a href="http://bower.io">Bower</a> package,
and can be installed with the following command:

```bash
$ bower install bootstrap-timepicker
bower install bootstrap-timepicker
```

You can also download our latest release (and any previous release)
Expand All @@ -44,28 +42,26 @@ Contributing

2. Install packages

``` bash
npm install
```bash
npm install
```

3. Use <a href="https://github.com/twitter/bower">Bower</a> to get the dev dependencies.

``` bash
$ bower install
```bash
bower install
```

4. Use <a href="www.gruntjs.com">Grunt</a> to run tests, compress assets, etc.

``` bash
$ grunt test // run jshint and jasmine tests
$ grunt watch // run jsHint and Jasmine tests whenever a file is changed
$ grunt compile // minify the js and css files
$ grunt gh-pages // push updates to gh-pages
$ grunt bump:[patch/minor/major] // bump the version
```bash
grunt test // run jshint and jasmine tests
grunt watch // run jsHint and Jasmine tests whenever a file is changed
grunt compile // minify the js and css files
```

- Please make it easy on me by covering any new features or issues
with <a href="http://pivotal.github.com/jasmine">Jasmine</a> tests.
with <a href="http://pivotal.github.com/jasmine">Jasmine</a> tests.
- If your changes need documentation, please take the time to update the docs.

Acknowledgements
Expand All @@ -74,4 +70,4 @@ Acknowledgements
Thanks to everyone who have given feedback and submitted pull requests. A
list of all the contributors can be found <a href="https://github.com/jdewit/bootstrap-timepicker/graphs/contributors">here</a>.

Special thanks to @eternicode and his <a href="https://github.com/eternicode/bootstrap-datepicker">Twitter Datepicker</a> for inspiration.
Special thanks to @eternicode and his <a href="https://github.com/eternicode/bootstrap-datepicker">Twitter Datepicker</a> for inspiration.

0 comments on commit 41b8d8c

Please sign in to comment.