Git Product home page Git Product logo

read-time's Introduction

Read Time

Latest Version on Packagist Tests Total Downloads

Simple package for displaying read time.

Installation

You can install the package via composer:

composer require leepownall/read-time

Usage

Using get()

$readTime = new Pownall\ReadTime\ReadTime('Hello, world!');

$readTime->get();

Using __toString()

$readTime = new Pownall\ReadTime\ReadTime('Hello, world!');

echo $readTime;

Using blade directive

@readtime('Hello, world!')

Pass in wordsPerMinute

$readTime = new Pownall\ReadTime\ReadTime('Hello, world!', 300);
@readtime('Hello, world!', 300)

Output

It uses Carbon under the hood, specifically forHumans on the CarbonInterval.

The output looks like

2 hours 4 minutes

Config

Default wordsPerMinute is 200. You can override this by passing it in, or publish the config and override there.

php artisan vendor:publish --tag=readtime-config

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

read-time's People

Contributors

dependabot[bot] avatar github-actions[bot] avatar leepownall avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.