README

Reading Time plugin shows the estimated reading time of the content, in seconds or minutes.

Requirements

• Craft CMS: ^4.0
• PHP: ^8.0

Installation

To install the plugin, follow these instructions.

1. Open your terminal and go to your Craft project:

   cd /path/to/project
   

2. In your terminal run composer require awilum/craft-reading-time.

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Reading Time.

Usage

Display reading time in the twig templates:

{{ readingTime('Some text here ...') }}

Display reading time with custom translates in the twig templates:

{{ readingTime('Some text here ...', {
                'minute': 'Minute',
                'minutes': 'Minutes',
                'second':  'Second',
                'seconds': 'Seconds'
                }) }}

Display reading time with custom translates and format in the twig templates:

{{ readingTime('Some text here ...', {
                'minute': 'Minute',
                'minutes': 'Minutes',
                'second':  'Second',
                'seconds': 'Seconds',
                'format': '[minutes_count] [minutes_label] – [seconds_count] [seconds_label]'
                }) }}

Display reading time with custom translates and format that with alternative format that hides the minutes and seconds label in the twig templates

{{ readingTime('Some text here ...', {
                'minute': 'Minute',
                'minutes': 'Minutes',
                'second':  'Second',
                'seconds': 'Seconds',
                'format': '[minutes_count] [minutes_label] – [seconds_count] [seconds_label]'
                }) }}

Also you can use readingTime filter in your twig templates:

{{ 'Some text here ...'|readingTime }}

Use readingTime function in the PHP:

use function Awilum\CraftReadingTime\readingTime;

echo readingTime('Some text here ...');

LICENSE

The MIT License (MIT) Copyright (c) Sergey Romanenko