Skip to content

Commit e5dcc67

Browse files
authored
Merge pull request #8 from DealerDirect/docs/sections
Adds section per package type in README.
2 parents e483864 + bb397a8 commit e5dcc67

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

README.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,34 @@ convenient way of installing all PHP Quality Assurance tools.
1616

1717
You'll get the following tools by depending on this package:
1818

19-
* **[Behat]**: BDD framework for PHP
20-
* **[Codeception]**: Modern full-stack testing framework for PHP
21-
* **[GrumPHP]**: Githooks for PHP QA tooling
19+
### Linters / Fixers
20+
2221
* **[JSON Lint]**: JSON Lint for PHP
23-
* **[Mink]**: PHP 5.3+ web browser emulator abstraction
24-
* **[ParaTest]**: Parallel testing for PHPUnit
2522
* **[PHP Coding Standards Fixer]**: A tool to automatically fix PHP coding standards issues
2623
* **[PHP Parallel Lint]**: Check syntax of PHP files faster than serial check with fancier output
2724
* **[PHP_CodeSniffer]**: Detects violations of a defined set of coding standards
28-
* **[PHP_Depend]**: Software metrics for PHP
2925
* **[php7cc]**: PHP 7 Compatibility Checker
26+
27+
### Quality Assistance
28+
29+
* **[GrumPHP]**: Githooks for PHP QA tooling
30+
* **[PHP_Depend]**: Software metrics for PHP
3031
* **[PHPCPD]**: Copy/Paste Detector
3132
* **[PHPLOC]**: Quickly measure the size of a PHP project
3233
* **[PhpMetrics]**: A static analysis tool for PHP
3334
* **[PHPMD]**: PHP Mess Detector
34-
* **[PHPUnit]**: Testing framework for PHP
3535
* **[SensioLabs Security Checker]**: Checks for dependencies with known security vulnerabilities
3636

37+
### Test Related
38+
39+
* **[Behat]**: BDD framework for PHP
40+
* **[Codeception]**: Modern full-stack testing framework for PHP
41+
* **[Mink]**: PHP 5.3+ web browser emulator abstraction
42+
* **[ParaTest]**: Parallel testing for PHPUnit
43+
* **[PHPUnit]**: Testing framework for PHP
44+
45+
### Other
46+
3747
Other packages that you'll get:
3848

3949
* **[Behat Mink]**: Mink extension for Behat
@@ -44,7 +54,10 @@ Other packages that you'll get:
4454
* **[PHPCompatibility]**: PHP Compatibility checks for PHP_CodeSniffer
4555
* **[prestissimo]**: Composer parallel install plugin
4656

57+
## Suggested
58+
4759
The following packages are suggested:
60+
4861
* **[ApiGen]**: Smart and Readable Documentation for your PHP project
4962
* **[Mockery]**: A simple yet flexible PHP mock object framework
5063
* **[PHP_CodeBrowser]**: A code browser that augments the code with information from various QA tools
@@ -66,8 +79,8 @@ The following packages are suggested:
6679
[php7cc]: https://github.com/sstalle/php7cc
6780
[PHPCPD]: https://github.com/sebastianbergmann/phpcpd
6881
[PHPLOC]: https://github.com/sebastianbergmann/phploc
69-
[PhpMetrics]: http://www.phpmetrics.org
7082
[PHPMD]: https://phpmd.org
83+
[PhpMetrics]: http://www.phpmetrics.org
7184
[PHPUnit]: https://phpunit.de
7285
[SensioLabs Security Checker]: https://security.sensiolabs.org
7386

@@ -77,14 +90,14 @@ The following packages are suggested:
7790
[Mink Selenium2 Driver]: https://github.com/minkphp/MinkSelenium2Driver
7891
[PHP_CodeSniffer Composer Installer]: https://github.com/DealerDirect/php-qa-tools
7992
[PHPCompatibility]: https://github.com/wimg/PHPCompatibility
80-
[prestissimo]: https://github.com/hirak/prestissimo
93+
[Prestissimo]: https://github.com/hirak/prestissimo
8194

8295
[ApiGen]: http://www.apigen.org
8396
[Mockery]: https://github.com/padraic/mockery
8497
[PHP_CodeBrowser]: https://github.com/mayflower/PHP_CodeBrowser
85-
[phpcov]: https://github.com/sebastianbergmann/phpcov
86-
[phpDocumentor]: https://www.phpdoc.org
87-
[phpDox]: http://phpdox.de
98+
[PhpCov]: https://github.com/sebastianbergmann/phpcov
99+
[PhpDocumentor]: https://www.phpdoc.org
100+
[PhpDox]: http://phpdox.de
88101
[Sami]: https://github.com/FriendsOfPHP/sami
89102

90103
## Usage

0 commit comments

Comments
 (0)