SHIP IT! :shipit:
This commit is contained in:
parent
efa0697c3a
commit
8c99148381
4 changed files with 119 additions and 2 deletions
36
README.md
36
README.md
|
@ -6,6 +6,38 @@
|
|||
>
|
||||
> — <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
|
||||
|
||||
There’s 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
|
||||
project’s 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]
|
||||
|
||||
[MediumReadTime]: https://medium.com/the-story/read-time-and-you-bc2048ab620c
|
||||
[joshtronic]: http://joshtronic.com
|
||||
[gittip]: https://www.gittip.com/joshtronic/
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue