πŸ“š Medium's like reading time estimation.
JavaScript
Permalink
Failed to load latest commit information.
lib πŸ”© update file headers Oct 21, 2016
test πŸ”© update file headers Oct 21, 2016
.editorconfig πŸ’„ old me was using tabs Oct 21, 2016
.eslintrc
.gitattributes initial commit. Mar 21, 2014
.gitignore
.jshintrc initial commit. Mar 21, 2014
.npmignore initial commit. Mar 21, 2014
.travis.yml
README.md πŸ“š remove useless badges Feb 28, 2016
index.js
license πŸ“š add license (#7) Sep 2, 2016
package.json 🌴 update dependencies (#8) Nov 30, 2016

README.md

reading-time

NPM Build Status


Medium's like reading time estimation.

reading-time helps you estimate how long an article will take to read. It works perfectly with plain text, but also with markdown or html.

Note that it's focused on performance and simplicity, so the number of words it will extract from other formats than plain text can vary a little. But this is an estimation right?

Installation

npm install reading-time --production

Usage

Classic

var readingTime = require('reading-time');

var stats = readingTime(text);
// ->
// stats: {
//   text: '1 min read',
//   time: 60000.
//   words: 200
// }

Stream

var readingTime = require('reading-time/stream');

fs.createReadStream('foo').pipe(readingTime).on('data', function(stats) {
    // ...
});

Author

twitter/ngryman
Nicolas Gryman