Retim

TODO: Add description

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. If available in Hex, the package can be installed by adding retim to your list of dependencies in mix.exs:

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

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/retim.

Hot 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 a file

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