SHIP IT! :shipit:

This commit is contained in:
Josh Sherman 2014-08-30 10:38:37 -04:00
parent efa0697c3a
commit 8c99148381
4 changed files with 119 additions and 2 deletions

View file

@ -6,6 +6,38 @@
>
> &mdash; <cite>[Read Time and You][MediumReadTime]</cite>
[MediumReadTime]: https://medium.com/the-story/read-time-and-you-bc2048ab620c
## Usage
### Basic
```javascript
$('article').readtime();
```
### Advanced
```javascript
$('article').readtime({
class: 'time-to-read',
format: 'This will take you # minutes to read',
wrapper: 'div'
});
```
## Contributing
Theres some room for improvement with the format of the time. Couple of
thoughts would be to allow it to be configured to return the time as a decimal
or even a fraction. Also could stand to put together some unit tests. Fork and
improve as you see fit. Pull requests are welcome but please conform to the
projects existing coding style.
## Author
Lovingly built one Saturday morning by [Josh Sherman][joshtronic]. You can
return the love by starring this project and/or tipping:
[![Gittip](http://img.shields.io/gittip/joshtronic.svg?style=flat)][gittip]
[MediumReadTime]: https://medium.com/the-story/read-time-and-you-bc2048ab620c
[joshtronic]: http://joshtronic.com
[gittip]: https://www.gittip.com/joshtronic/