https://github.com/iaguirre88/reading_time

ReadingTime helps you estimate how long some text will take to be read
https://github.com/iaguirre88/reading_time

elixir estimate hacktoberfest readingtime

Last synced: 3 days ago
JSON representation

ReadingTime helps you estimate how long some text will take to be read

• Host: GitHub
• URL: https://github.com/iaguirre88/reading_time
• Owner: iaguirre88
• License: mit
• Created: 2020-09-24T03:18:26.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-10-06T20:49:49.000Z (about 4 years ago)
• Last Synced: 2024-09-21T14:13:34.864Z (about 2 months ago)
• Topics: elixir, estimate, hacktoberfest, readingtime
• Language: Elixir
• Homepage:
• Size: 22.5 KB
• Stars: 7
• Watchers: 1
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ReadingTime

[![Hex pm](https://img.shields.io/hexpm/v/reading_time.svg?style=flat&color=78529a)](https://hex.pm/packages/reading_time)

[![Build Status](https://travis-ci.com/iaguirre88/reading_time.svg?branch=master)](https://travis-ci.com/iaguirre88/reading_time)

---

Medium's like reading time estimation for Elixir.

ReadingTime helps you estimate how long a text will take to be read.

This is based on [reading-time](https://github.com/ngryman/reading-time) for

JavaScript.

## Installation

This package can be installed by adding `reading_time` to your list of

dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:reading_time, "~> 0.1.0"}

  ]

end

```

## Usage

```elixir

ReadingTime.time("this is a random text")

# 1

ReadingTime.time("this_is_a-random-text",

  words_per_minute: 1,

  split_pattern: ["_", "-"]

)

# 5

```

The docs can be found at [https://hexdocs.pm/reading_time](https://hexdocs.pm/reading_time).