kdaviesnz/spinner

spinner

Spinner

![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/spinner, <sub>(*6)</sub>

## Usage

``` php

        $text = "It was the best of times, it was the worst of times, it was the age of wisdom, it was the age of foolishness, it was the epoch of belief, it was the epoch of incredulity, it was the season of Light, it was the season of Darkness, it was the spring of hope, it was the winter of despair, we had everything before us, we had nothing before us, we were all going direct to Heaven, we were all going direct the other way – in short, the period was so far like the present period, that some of its noisiest authorities insisted on its being received, for good or for evil, in the superlative degree of comparison only.";
        $spinner = new \kdaviesnz\spinner\Spinner($text, 'me@example.com', "blahblah");
        echo $spinner;

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>

spinner