Retim

Estimate the reading time of a text or a text file

Installation

You can donwload retim or you can install it as package to use it in your projects. You can found it at https://hex.pm/packages/retim. Also you can add retim to your list of dependencies in mix.exs:

def deps do
  [{:retim, "~> 0.2.0"}]
end

How to use it

Estimate the reading time of a setence:

iex> Retim.count("Hello World")
"1 minute"

The average reading time per minute is 180 words. If you want to change it you can pass a second argument:

iex> Retim.count("Hello World", 140)
"1 minute"

Read words from a file:

iex> Retim.count_file("hello.md")
"4 minutes"

Read a file and change the average reading time to 120 words / per minute:

iex> Retim.count_file("hello.md", 120)
"7 minutes"

Use Retim on Phoenix

Add retim on your dependencies:

 defp deps do
    [{:phoenix, "~> 1.2.1"},
      ........
      ........
     {:cowboy, "~> 1.0"},
     {:retim, "~> 0.2.0"}]
  end

Run deps.get on your terminal:

mix deps.get

Example

Generate a post:

mix phoenix.gen.html Post posts title:string body:text

To count the reading time of the body text, add count(@post.body) on your templates(post/show.html.eex):

<%= Retim.count(@post.body) %>

Result

To-do

• Add new print format (Example: 3 minutes and 10 seconds)
• Add other languages