ReadTimeEstimator 1.0.0

A tool to determine the estimated read time for HTML or Markdown articles

Install-Package ReadTimeEstimator -Version 1.0.0
dotnet add package ReadTimeEstimator --version 1.0.0
<PackageReference Include="ReadTimeEstimator" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ReadTimeEstimator --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Read Time Estimator

Build status
codecov License: MIT NuGet Badge

This library aims to give as accurate an estimate of the read time for an article in HTML or Markdown.

Installation

You can install the package from nuget

Install-Package ReadTimeEstimator

or

dotnet add package ReadTimeEstimator

or for paket

paket add ReadTimeEstimator

Usage

This package provided two estimators, one for HTML and one for Markdown, HtmlEstimator and MarkdownEstimator respectively. On each estimator, two methods are provided for retrieving the time estimates. ReadTimeInMinutes returns a double value which is the estimated read time in minutes. HumanFriendlyReadTime returns a string which is the read time in human friendly form.

A classic usage example:

using ReadTimeEstimator.Implementations.Estimators;

...

var htmlEstimator = new HtmlEstimator();
var markdownEstimator = new MarkdownEstimator();
var htmlReadTime = htmlEstimator.ReadTimeInMinutes("<div>Hello World</div>"); // 0.00727
var markdownReadTime = markdownEstimator.HumanFriendlyReadTime("# Hello World"); // less than a minute

Read Time Estimator

Build status
codecov License: MIT NuGet Badge

This library aims to give as accurate an estimate of the read time for an article in HTML or Markdown.

Installation

You can install the package from nuget

Install-Package ReadTimeEstimator

or

dotnet add package ReadTimeEstimator

or for paket

paket add ReadTimeEstimator

Usage

This package provided two estimators, one for HTML and one for Markdown, HtmlEstimator and MarkdownEstimator respectively. On each estimator, two methods are provided for retrieving the time estimates. ReadTimeInMinutes returns a double value which is the estimated read time in minutes. HumanFriendlyReadTime returns a string which is the read time in human friendly form.

A classic usage example:

using ReadTimeEstimator.Implementations.Estimators;

...

var htmlEstimator = new HtmlEstimator();
var markdownEstimator = new MarkdownEstimator();
var htmlReadTime = htmlEstimator.ReadTimeInMinutes("<div>Hello World</div>"); // 0.00727
var markdownReadTime = markdownEstimator.HumanFriendlyReadTime("# Hello World"); // less than a minute

Release Notes

- initial release

  • .NETStandard 2.0

GitHub repositories (0)

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.0.0 409 4/4/2020