Skip to content

Commit 68f6fd1

Browse files
Initial commit
0 parents  commit 68f6fd1

File tree

1 file changed

+83
-0
lines changed

1 file changed

+83
-0
lines changed

Diff for: README.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# :package_name
2+
3+
[![Latest Version on Packagist][ico-version]][link-packagist]
4+
[![Software License][ico-license]](LICENSE.md)
5+
[![Build Status][ico-travis]][link-travis]
6+
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
7+
[![Quality Score][ico-code-quality]][link-code-quality]
8+
[![Total Downloads][ico-downloads]][link-downloads]
9+
10+
**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.
11+
12+
This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what
13+
PSRs you support to avoid any confusion with users and contributors.
14+
15+
## Structure
16+
17+
If any of the following are applicable to your project, then the directory structure should follow industry best practises by being named the following.
18+
19+
```
20+
bin/
21+
config/
22+
src/
23+
tests/
24+
vendor/
25+
```
26+
27+
28+
## Install
29+
30+
Via Composer
31+
32+
``` bash
33+
$ composer require :vendor/:package_name
34+
```
35+
36+
## Usage
37+
38+
``` php
39+
$skeleton = new League\Skeleton();
40+
echo $skeleton->echoPhrase('Hello, League!');
41+
```
42+
43+
## Change log
44+
45+
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
46+
47+
## Testing
48+
49+
``` bash
50+
$ composer test
51+
```
52+
53+
## Contributing
54+
55+
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
56+
57+
## Security
58+
59+
If you discover any security related issues, please email :author_email instead of using the issue tracker.
60+
61+
## Credits
62+
63+
- [:author_name][link-author]
64+
- [All Contributors][link-contributors]
65+
66+
## License
67+
68+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
69+
70+
[ico-version]: https://img.shields.io/packagist/v/:vendor/:package_name.svg?style=flat-square
71+
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
72+
[ico-travis]: https://img.shields.io/travis/:vendor/:package_name/master.svg?style=flat-square
73+
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/:vendor/:package_name.svg?style=flat-square
74+
[ico-code-quality]: https://img.shields.io/scrutinizer/g/:vendor/:package_name.svg?style=flat-square
75+
[ico-downloads]: https://img.shields.io/packagist/dt/:vendor/:package_name.svg?style=flat-square
76+
77+
[link-packagist]: https://packagist.org/packages/:vendor/:package_name
78+
[link-travis]: https://travis-ci.org/:vendor/:package_name
79+
[link-scrutinizer]: https://scrutinizer-ci.com/g/:vendor/:package_name/code-structure
80+
[link-code-quality]: https://scrutinizer-ci.com/g/:vendor/:package_name
81+
[link-downloads]: https://packagist.org/packages/:vendor/:package_name
82+
[link-author]: https://github.com/:author_username
83+
[link-contributors]: ../../contributors

0 commit comments

Comments
 (0)