diff --git a/README.md b/README.md index e6382f7..d446bd3 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,14 @@ # PHPCompatibilityAll -Convenience package to install all the external rulesets which the [PHPCompatibility organisation](https://github.com/PHPCompatibility) maintains, in one go using Composer. +Convenience package to install all the external PHP_CodeSniffer rulesets which the [PHPCompatibility organisation](https://github.com/PHPCompatibility) maintains, in one go using Composer. ## What's included in this package ? ### Base ruleset -- [![PHPCompatibility Current Version](https://poser.pugx.org/phpcompatibility/php-compatibility/v/stable.png)](https://packagist.org/packages/phpcompatibility/php-compatibility) [PHPCompatibility](https://github.com/PHPCompatibility/PHPCompatibility) - External PHPCS standard to check your codebase for PHP cross-version compatibility. +- [![PHPCompatibility Current Version](https://poser.pugx.org/phpcompatibility/php-compatibility/v/stable.png)](https://packagist.org/packages/phpcompatibility/php-compatibility) [PHPCompatibility](https://github.com/PHPCompatibility/PHPCompatibility) - External PHP_CodeSniffer standard to check your codebase for PHP cross-version compatibility. ### Framework/CMS specific rulesets @@ -45,7 +45,7 @@ Next, run: ```bash vendor/bin/phpcs -i ``` -If all went well, you will now see that the PHPCompatibility, PHPCompatibilityJoomla and PHPCompatibilityWP standards are installed for PHP_CodeSniffer. +If all went well, you will now see that the `PHPCompatibility`, `PHPCompatibilityJoomla` and `PHPCompatibilityWP` standards are installed for PHP_CodeSniffer. ## How to use @@ -60,16 +60,18 @@ Now you can use any of the following commands to inspect your code: By default, you will only receive notifications about deprecated and/or removed PHP features. To get the most out of the PHPCompatibility standards, you should specify a `testVersion` to check against. That will enable the checks for both deprecated/removed PHP features as well as the detection of code using new PHP features. - - You can run the checks for just one specific PHP version by adding `--runtime-set testVersion 5.5` to your command line command. - - You can also specify a range of PHP versions that your code needs to support. In this situation, compatibility issues that affect any of the PHP versions in that range will be reported: `--runtime-set testVersion 5.3-5.5`. - - Since PHPCompatibility 7.1.3, you can omit one part of the range if you want to support everything above or below a particular version, i.e. use `--runtime-set testVersion 7.0-` to run all the checks for PHP 7.0 and above. + +* You can run the checks for just one specific PHP version by adding `--runtime-set testVersion 5.5` to your command line command. +* You can also specify a range of PHP versions that your code needs to support. In this situation, compatibility issues that affect any of the PHP versions in that range will be reported: `--runtime-set testVersion 5.3-5.5`. +* Since PHPCompatibility 7.1.3, you can omit one part of the range if you want to support everything above or below a particular version, i.e. use `--runtime-set testVersion 7.0-` to run all the checks for PHP 7.0 and above. For more detailed information, see the README of the main [PHPCompatibility](https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions) standard. ## License -All code within the PHPCompatibility organisation is released under the GNU Lesser General Public License (LGPL). For more information, visit https://www.gnu.org/copyleft/lesser.html +All code within the PHPCompatibility organisation is released under the GNU Lesser General Public License (LGPL). +For more information, visit https://www.gnu.org/copyleft/lesser.html ## Changelog