https://github.com/bolorundurowb/read-time-estimator

Estimate read times for HTML and Markdown articles
https://github.com/bolorundurowb/read-time-estimator

csharp dotnet read-time-estimator

Last synced: 5 months ago
JSON representation

Estimate read times for HTML and Markdown articles

• Host: GitHub
• URL: https://github.com/bolorundurowb/read-time-estimator
• Owner: bolorundurowb
• License: mit
• Created: 2020-04-03T22:42:01.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2025-09-08T01:35:33.000Z (10 months ago)
• Last Synced: 2025-10-25T09:58:58.786Z (9 months ago)
• Topics: csharp, dotnet, read-time-estimator
• Language: C#
• Size: 54.7 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# ⏳ Read Time Estimator  

[![Build, Test, and Upload Coverage](https://github.com/bolorundurowb/read-time-estimator/actions/workflows/build.yml/badge.svg)](https://github.com/bolorundurowb/read-time-estimator/actions/workflows/build.yml)  [![Code Coverage](https://codecov.io/gh/bolorundurowb/read-time-estimator/branch/master/graph/badge.svg)](https://codecov.io/gh/bolorundurowb/read-time-estimator)  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)  ![NuGet Version](https://img.shields.io/nuget/v/ReadTimeEstimator)

 

📖 **Read Time Estimator** is a library that provides an accurate estimate of the read time for an article in **HTML** or **Markdown**.

---

## 📦 Installation  

You can install the package via **NuGet**:  

```sh

Install-Package ReadTimeEstimator

```

Or using **.NET CLI**:

```sh

dotnet add package ReadTimeEstimator

```

Or with **Paket**:

```sh

paket add ReadTimeEstimator

```

---

## 🚀 Usage

This package provides two estimators:

- 🖥️ `HtmlEstimator` for HTML content

- ✍️ `MarkdownEstimator` for Markdown content

Each estimator offers two methods for retrieving time estimates:

- ⏱️ `ReadTimeInMinutes()` → Returns a `double` (estimated read time in minutes).

- 🗣️ `HumanFriendlyReadTime()` → Returns a `string` (human-friendly read time).

### ✅ Example Usage:

```csharp

using ReadTimeEstimator.Implementations.Estimators;

var htmlEstimator = new HtmlEstimator();

var markdownEstimator = new MarkdownEstimator();

var htmlReadTime = htmlEstimator.ReadTimeInMinutes("
Hello World
"); // 0.00727

var markdownReadTime = markdownEstimator.HumanFriendlyReadTime("# Hello World"); // "less than a minute"

```


🔹 Now you can easily estimate reading time for your content! 🚀