6012b85273
Because most repos don't do releases, they just tag their revisons. Which suffices for Composer/Packagist - but the current badge would simply state "Release: None"... Alternatively the GH Tag badge could be used instead.
56 lines
2.2 KiB
Markdown
56 lines
2.2 KiB
Markdown
# :package_name
|
|
|
|
[](https://packagist.org/packages/league/:package_name)
|
|
[](LICENSE.md)
|
|
[](https://travis-ci.org/thephpleague/:package_name)
|
|
[](https://scrutinizer-ci.com/g/thephpleague/:package_name/code-structure)
|
|
[](https://scrutinizer-ci.com/g/thephpleague/:package_name)
|
|
[](https://packagist.org/packages/league/:package_name)
|
|
|
|
**Note:** Replace ```:author_name``` ```:author_username``` ```:author_website``` ```:author_email``` ```: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.
|
|
|
|
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.
|
|
|
|
## Install
|
|
|
|
Via Composer
|
|
|
|
``` bash
|
|
$ composer require league/:package_name
|
|
```
|
|
|
|
## Usage
|
|
|
|
``` php
|
|
$skeleton = new League\Skeleton();
|
|
echo $skeleton->echoPhrase('Hello, League!');
|
|
```
|
|
|
|
## Change log
|
|
|
|
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
|
|
|
|
## Testing
|
|
|
|
``` bash
|
|
$ composer test
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
|
|
|
|
## Security
|
|
|
|
If you discover any security related issues, please email :author_email instead of using the issue tracker.
|
|
|
|
## Credits
|
|
|
|
- [:author_name](https://github.com/:author_username)
|
|
- [All Contributors](../../contributors)
|
|
|
|
## License
|
|
|
|
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
|