retim v0.1.5 Retim

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

Summary

Functions

Count the words of a setence

The estimate_reading_method count the reading time

The print_reading_time method print the final result

Functions

count(setence, average_reading_time \\ 180)

Count the words of a setence

Examples

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

iex> Retim.count("Hello World", 120)
"1 minute"
count_file(setence, 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", 120)
"7 minutes"
estimate_reading_time(setence, average_reading_time)

The estimate_reading_method count the reading time.