ReadTimeEstimator 1.0.0

dotnet add package ReadTimeEstimator --version 1.0.0                
NuGet\Install-Package ReadTimeEstimator -Version 1.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<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                
#r "nuget: ReadTimeEstimator, 1.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ReadTimeEstimator as a Cake Addin
#addin nuget:?package=ReadTimeEstimator&version=1.0.0

// Install ReadTimeEstimator as a Cake Tool
#tool nuget:?package=ReadTimeEstimator&version=1.0.0                

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
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 2,158 4/4/2020

- initial release