mdwheele/sculpin-readtime

A Sculpin bundle for calculating read time, similar to Medium.

dev-master 2017-09-27 06:20 UTC

Requires

• php: >=5.4.0
• sculpin/sculpin: ~2.0@dev

MIT

• Dustin Wheeler

• bundle
• extension
• sculpin
• read time

README

This Sculpin bundle calculates an estimated read time for posts accessible via a post attribute.

Installation

Add mdwheele/sculpin-readtime as a requirement to your sculpin.json (if using Sculpin as a phar) or composer.json (if using Sculpin via Composer).

Then, add the bundle to your SculpinKernel. For example:

<?php

use Blog\Sculpin\Bundle\ReadTimeBundle\BlogSculpinReadTimeBundle;
use Sculpin\Bundle\SculpinBundle\HttpKernel\AbstractKernel;

class SculpinKernel extends AbstractKernel
{
    protected function getAdditionalSculpinBundles()
    {
        return [
            MdwheeleSculpinReadTimeBundle::class
        ];
    }
}

Usage

Read time is available as a property called read_time on the page object.

{{ page.read_time }}

For more information, see the Sculpin Configuration documentation.