πŸ“š Medium's like reading time estimation.
Fetching latest commit…
Cannot retrieve the latest commit at this time.

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',
//   minutes: 1,
//   time: 60000,
//   words: 200
// }

Stream

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

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

API

readingTime(text, options)

  • text: the text to analyze
  • options.wordsPerMinute: the words per minute an average reader can read (default: 200)
  • options.wordBound: a function than return if a character is considered as a word bound (default: spaces, new lines and tabulations)

Author

twitter/ngryman
Nicolas Gryman