alnutile/example

dev-master / 1.0.x-dev 2017-06-18 18:36 UTC

README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

Note: Replace Al Nutile alnutile https://github.com/alnutile alfrednutile@gmail.com alnutile example Foo 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.

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.

This will create a CLI foundation using Silly

It is based off the thephpleague/skeleton library

THIS IS 99% BASED ON https://github.com/thephpleague/skeleton TOTALLY APPRECIATE THEIR WORK

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.

bin/        
config/
src/
tests/
vendor/

Install

Via Composer

$ composer require alnutile/example

Global Install Notes

This is how a user can install this for a reliable global install:

Usage

$skeleton = new Alnutile\Example();
echo $skeleton->echoPhrase('League!', 'Hello');

Change log

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

Testing

if you get an error change the extend of src/SkeletonClass.php to \PHPUnit\Framework\TestCase your install might have setup PHPUnit 6

$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email alfrednutile@gmail.com instead of using the issue tracker.

Credits

License

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