Skip to content

Commit 71408d7

Browse files
committed
Added README.md
1 parent 55bb922 commit 71408d7

File tree

1 file changed

+81
-0
lines changed

1 file changed

+81
-0
lines changed

README.md

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

0 commit comments

Comments
 (0)