Skip to content

Commit

Permalink
Merge pull request #9 from lukeyouell/develop
Browse files Browse the repository at this point in the history
1.3.0
  • Loading branch information
lukeyouell authored Jun 22, 2018
2 parents 92a0626 + 236a543 commit 160e2d9
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ The average user read speed is set at 200 words per minute by default, this can

## Using the Filter

The `|readTime` filter returns the human time duration of how long it takes the average user to read the provided content. The value provided can be a string or an array of values.
The `|readTime` filter returns a [TimeModel](#timemodel) of how long it takes the average user to read the provided content. The value provided can be a string or an array of values.

Seconds are included by default, but can be disabled by using `|readTime(false)`
Seconds are included by default, but can be disabled by using `|readTime(false)` - this only affects the human time format.

#### Examples

Expand All @@ -62,9 +62,9 @@ Returns: 3 minutes

## Using the Function

The `readTime()` function returns the average read time for the whole entry based on it's field layout.
The `readTime()` function returns a [TimeModel](#timemodel) for the whole entry based on it's field layout.

Seconds are included by default, but can be disabled by adding a second parameter of `false`
Seconds are included by default, but can be disabled by adding a second parameter of `false` - this only affects the human time format.

#### Examples

Expand Down

0 comments on commit 160e2d9

Please sign in to comment.