2014-12-30 15:31:21 +00:00
# :package_name
2013-08-07 17:33:05 +00:00
2015-06-24 08:24:44 +00:00
[![Latest Version on Packagist][ico-version]][link-packagist]
2015-02-20 21:36:34 +00:00
[![Software License][ico-license]](LICENSE.md)
[![Build Status][ico-travis]][link-travis]
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
[![Quality Score][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]
2013-08-07 17:33:05 +00:00
2016-08-22 00:51:31 +00:00
**Note:** Replace ```:author_name``` ```:author_username``` ```:author_website``` ```:author_email``` ```:vendor``` ```:package_name``` ```:package_description``` with their correct values in [README.md ](README.md ), [CHANGELOG.md ](CHANGELOG.md ), [CONTRIBUTING.md ](CONTRIBUTING.md ), [LICENSE.md ](LICENSE.md ) and [composer.json ](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.
2013-08-07 17:33:05 +00:00
2014-10-27 03:01:45 +00:00
This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what
2014-10-14 20:52:07 +00:00
PSRs you support to avoid any confusion with users and contributors.
2013-08-07 17:33:05 +00:00
2016-12-15 18:26:32 +00:00
## Structure
2017-12-26 22:35:57 +00:00
If any of the following are applicable to your project, then the directory structure should follow industry best practices by being named the following.
2016-12-15 18:26:32 +00:00
```
bin/
config/
src/
2017-01-18 11:15:05 +00:00
tests/
2016-12-15 18:28:35 +00:00
vendor/
2016-12-15 18:26:32 +00:00
```
2013-08-07 17:33:05 +00:00
## Install
Via Composer
2014-10-14 20:52:07 +00:00
``` bash
2015-11-27 22:08:09 +00:00
$ composer require :vendor/:package_name
2013-08-07 17:33:05 +00:00
```
## Usage
``` php
$skeleton = new League\Skeleton();
echo $skeleton->echoPhrase('Hello, League!');
```
2015-05-13 18:56:38 +00:00
## Change log
2016-12-13 20:57:58 +00:00
Please see [CHANGELOG ](CHANGELOG.md ) for more information on what has changed recently.
2015-05-13 18:56:38 +00:00
2013-08-07 17:33:05 +00:00
## Testing
``` bash
2015-05-14 17:45:15 +00:00
$ composer test
2013-08-07 17:33:05 +00:00
```
## Contributing
2017-08-21 20:30:22 +00:00
Please see [CONTRIBUTING ](CONTRIBUTING.md ) and [CODE_OF_CONDUCT ](CODE_OF_CONDUCT.md ) for details.
2013-08-07 17:33:05 +00:00
2015-02-04 19:40:00 +00:00
## Security
If you discover any security related issues, please email :author_email instead of using the issue tracker.
2013-08-07 17:33:05 +00:00
## Credits
2015-02-20 21:36:34 +00:00
- [:author_name][link-author]
- [All Contributors][link-contributors]
2013-08-07 17:33:05 +00:00
## License
2014-10-25 20:57:34 +00:00
The MIT License (MIT). Please see [License File ](LICENSE.md ) for more information.
2015-02-20 21:36:34 +00:00
2015-11-27 22:08:09 +00:00
[ico-version]: https://img.shields.io/packagist/v/:vendor/:package_name.svg?style=flat-square
2015-02-20 21:36:34 +00:00
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
2015-11-27 22:08:09 +00:00
[ico-travis]: https://img.shields.io/travis/:vendor/:package_name/master.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/:vendor/:package_name.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/:vendor/:package_name.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/:vendor/:package_name.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/:vendor/:package_name
[link-travis]: https://travis-ci.org/:vendor/:package_name
[link-scrutinizer]: https://scrutinizer-ci.com/g/:vendor/:package_name/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/:vendor/:package_name
[link-downloads]: https://packagist.org/packages/:vendor/:package_name
2015-02-20 21:36:34 +00:00
[link-author]: https://github.com/:author_username
[link-contributors]: ../../contributors