joshtronic/jquery.readtime
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Boom, read time.
7 commits 1 branch 0 tags 36 KiB
Find a file
Exact
Josh Sherman b9c9da2dc1 Merge branch 'master' of github.com:joshtronic/jquery.readtime
2014-09-03 22:05:49 -04:00
build Gruntified and added more options 2014-09-03 22:04:59 -04:00
examples Gruntified and added more options 2014-09-03 22:04:59 -04:00
src Gruntified and added more options 2014-09-03 22:04:59 -04:00
.gitignore Gruntified and added more options 2014-09-03 22:04:59 -04:00
Gruntfile.js Gruntified and added more options 2014-09-03 22:04:59 -04:00
LICENSE Initial commit 2014-08-30 09:32:03 -04:00
package.json Gruntified and added more options 2014-09-03 22:04:59 -04:00
README.md Update README.md 2014-08-30 13:04:06 -04:00

README.md

jquery.readtime

Read time is based on the average reading speed of an adult (roughly 275 WPM). We take the total word count of a post and translate it into minutes. Then, we add 12 seconds for each inline image. Boom, read time.

— Read Time and You

Usage

Basic

$('article').readtime();

Advanced

$('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. You can return the love by starring this project and/or tipping: Gittip