kdaviesnz/timetoread

Gets how long some text will take to read based not just on the length of text but difficulty.

Readability

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Total Downloads][ico-downloads], _(*1)

Note: Replace :author_name :author_username :author_website :author_email :vendor :package_name :package_description with their correct values in README.md, CHANGELOG.md, CONTRIBUTING.md, LICENSE.md and composer.json files, then delete this line. You can run $ php prefill.php in the command line to make all replacements at once. Delete the file prefill.php as well., _(*2)

This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors., _(*3)

Structure

If any of the following are applicable to your project, then the directory structure should follow industry best practises by being named the following., _(*4)

bin/        
config/
src/
tests/
vendor/

Install

Via Composer, _(*5)

``` bash $ composer require kdaviesnz/timetoread, <sub>(*6)</sub>

## Usage

``` php
$fc = new \kdaviesnz\timetoread\TimeToRead("Hello world.");
echo $fc;

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*7)</sub>

Testing

bash $ composer test, <sub>(*8)</sub>

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details., <sub>(*9)</sub>

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker., <sub>(*10)</sub>

Credits

• :author_name
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*11)</sub>

timetoread