example
![Software License][ico-license]
![Coverage Status][ico-scrutinizer]
![Total Downloads][ico-downloads], (*1)
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., (*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)
This will create a CLI foundation using Silly, (*4)
It is based off the thephpleague/skeleton library, (*5)
THIS IS 99% BASED ON https://github.com/thephpleague/skeleton
TOTALLY APPRECIATE THEIR WORK, (*6)
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., (*7)
bin/
config/
src/
tests/
vendor/
Install
Via Composer, (*8)
``` bash
$ composer require alnutile/example, (*9)
## Global Install Notes
This is how a user can install this for a reliable global install:
## Usage
``` php
$skeleton = new Alnutile\Example();
echo $skeleton->echoPhrase('League!', 'Hello');
Change log
Please see CHANGELOG for more information on what has changed recently., (*10)
Testing
if you get an error change the extend of
src/SkeletonClass.php to \PHPUnit\Framework\TestCase
your install might have setup PHPUnit 6, (*11)
bash
$ composer test, (*12)
Contributing
Please see CONTRIBUTING and CONDUCT for details., (*13)
Security
If you discover any security related issues, please email alfrednutile@gmail.com instead of using the issue tracker., (*14)
Credits
License
The MIT License (MIT). Please see License File for more information., (*15)