PHP download

Download the PHP package shtayeb/bookworm without Composer

On this page you can find all versions of the php package shtayeb/bookworm. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download shtayeb/bookworm
More information about shtayeb/bookworm
Files in shtayeb/bookworm

Vendor shtayeb
Package bookworm
Short Description Bookworm estimates how much time is needed to read a certain piece of text.
License MIT

Keywords text time reading estimated

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of shtayeb/bookworm

Informations about the package bookworm

Bookworm For Laravel (by shtayeb)

Bookworm estimates how much time is needed to read a certain piece of text.

Installation

Publish the config file

Usage

API

Parameters

$text The piece of text which the estimation should be based upon.
$units = [ ' minute', ' minutes' ] Optional. Set it false, to return just the number of minutes as an integer. If you provide a string, like m it will be used for singular and plural and produce 5m. If you provide an array with two values, the first will be used for singular, the second for plural. [ ' minute', ' minutes' ] (not included leading whitespace) will produce 5 minutes.

Returns int or string

Configuration

You can configure Bookworm to react other than how it's shipped. You can change the average words per minute & the duration a user needs to look at an image. If you do not want images to factor into the reading time estimate, just set it to 0.

wordsPerMinute The average amount of words a user will read per minute (default 200).

codewordsPerMinute The average amount of words in a code block, a user will read per minute (default 200).

secondsPerImage The average amount of seconds a user will spend looking at an image (default 12).

License

This project is licensed under MIT license. For the full copyright and license information, please view the LICENSE file that was distributed with this source code.

Contributing

You may contribute in any way you want, as long as you agree that your code will be licensed under the same license as the project itself.

Please make sure to run the tests before committing.

All versions of bookworm with dependencies

PHP Build Version

Package Version

Version 1.0.2 Release 11. Apr 2023
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of bookworm from vendor shtayeb

Requires php Version ^8.1

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package shtayeb/bookworm contains the following files

Loading the files please wait ....