Skip to content

Commit 5b58c26

Browse files
committed
Update LICENSE.md and README.md
1 parent c0d05b7 commit 5b58c26

File tree

2 files changed

+86
-1
lines changed

2 files changed

+86
-1
lines changed

LICENSE renamed to LICENSE.md

File renamed without changes.

README.md

+86-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,86 @@
1-
# jazzpicon
1+
# jazzpicon
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+
Say goodbye to boring blocky identicons that look like they came out of the 70s, and replace them with jazzy, colorful collages that more likely came out of the 80's. =)
11+
12+
## Structure
13+
14+
If any of the following are applicable to your project, then the directory structure should follow industry best practises by being named the following.
15+
16+
```
17+
bin/
18+
config/
19+
src/
20+
tests/
21+
vendor/
22+
```
23+
24+
25+
## Install
26+
27+
Via Composer
28+
29+
``` bash
30+
$ composer require dkepov/jazzpicon
31+
```
32+
33+
## Usage
34+
35+
``` php
36+
$skeleton = new dkepov\jazzpicon();
37+
echo $skeleton->echoPhrase('Hello, League!');
38+
```
39+
40+
## Examples
41+
42+
```
43+
php -S localhost:8000 -t examples/
44+
```
45+
46+
## Change log
47+
48+
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
49+
50+
## Testing
51+
52+
``` bash
53+
$ composer test
54+
```
55+
56+
## Contributing
57+
58+
Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
59+
60+
## Security
61+
62+
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
63+
64+
## Credits
65+
66+
- [dkepov][link-author]
67+
- [All Contributors][link-contributors]
68+
69+
## License
70+
71+
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
72+
73+
[ico-version]: https://img.shields.io/packagist/v/dkepov/jazzpicon.svg?style=flat-square
74+
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
75+
[ico-travis]: https://img.shields.io/travis/dkepov/jazzpicon/master.svg?style=flat-square
76+
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/dkepov/jazzpicon.svg?style=flat-square
77+
[ico-code-quality]: https://img.shields.io/scrutinizer/g/dkepov/jazzpicon.svg?style=flat-square
78+
[ico-downloads]: https://img.shields.io/packagist/dt/dkepov/jazzpicon.svg?style=flat-square
79+
80+
[link-packagist]: https://packagist.org/packages/dkepov/jazzpicon
81+
[link-travis]: https://travis-ci.org/dkepov/jazzpicon
82+
[link-scrutinizer]: https://scrutinizer-ci.com/g/dkepov/jazzpicon/code-structure
83+
[link-code-quality]: https://scrutinizer-ci.com/g/dkepov/jazzpicon
84+
[link-downloads]: https://packagist.org/packages/dkepov/jazzpicon
85+
[link-author]: https://github.com/dkepov
86+
[link-contributors]: ../../contributors

0 commit comments

Comments
 (0)