retim v0.2.3 Retim

Provide methods to estimate the reading time of a file or a setence.

Summary

Functions

count(setence, lang \\ "en", average_reading_time \\ 180)

Count the words of a setence

count_file(setence, lang \\ "en", average_reading_time \\ 180)

Count the words of a file

Functions

count(setence, lang \\ "en", average_reading_time \\ 180)

Count the words of a setence

Examples

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

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

iex> Retim.count("Hellow World", "es", 120)
"1 minuto"

count_file(setence, lang \\ "en", average_reading_time \\ 180)

Count the words of a file.

Examples

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

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

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