README

Bookworm 估算阅读特定文本所需的时间。

安装

composer require shtayeb/bookworm

发布配置文件

php artisan vendor:publish --provider="SHTayeb\Bookworm\BookwormServiceProvider"

使用方法

<?php
use SHTayeb\Bookworm\Bookworm;

$text = '...';
$time = (new Bookworm())->estimate($text);
echo $time; // 5 minutes

$word_count = (new Bookworm())->countWords($text);
echo $word_count; // 1,000

API

(new Bookworm())->estimate(string $text, string|array|bool $units = [ ' minute', ' minutes' ]);

参数

• $text 应基于此文本估算的时间。
• $units = [ '分钟', '分钟' ] 可选。 设置为 false，则仅返回整数形式的分钟数。如果提供一个字符串，如 m，则它将用于单数和复数形式，并产生 5m。如果您提供一个包含两个值的数组，则第一个值用于单数，第二个值用于复数。[ '分钟', '分钟' ] (不包括前导空格) 将产生 5分钟。

返回值 int 或 string

配置

您可以将 Bookworm 配置为以不同于其发行版的方式反应。您可以更改每分钟平均阅读的字数以及用户查看图像所需的时间。如果您不希望图像影响阅读时间估算，只需将其设置为 0 即可。

return [
    /*
    |--------------------------------------------------------------------------
    | Bookworm Options
    |--------------------------------------------------------------------------
    | Here you may specify the configuration options that should be used
    |
    */

    'words_per_minute' =>200,
    'codewords_per_minute' => 200,
    'seconds_per_image' => 12

];

wordsPerMinute 用户每分钟平均阅读的字数（默认 200）。

codewordsPerMinute 用户每分钟平均阅读代码块中的字数（默认 200）。

secondsPerImage 用户查看图像的平均秒数（默认 12）。

许可证

本项目采用 MIT 许可证。有关完整的版权和许可信息，请查看与源代码一起分发的 LICENSE 文件。

贡献

您可以通过任何方式贡献，只要您同意您的代码将以与项目相同的许可证进行许可。

请在提交前确保运行测试。

$ composer test