Skip to content

Commit 27d0ef1

Browse files
authored
Merge pull request #4 from PHPCompatibility/feature/readme-fix-markdown
Readme: minor fixes for readability of the Readme
2 parents 7aaa885 + b04d71f commit 27d0ef1

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33

44
# PHPCompatibilityAll
55

6-
Convenience package to install all the external rulesets which the [PHPCompatibility organisation](https://github.com/PHPCompatibility) maintains, in one go using Composer.
6+
Convenience package to install all the external PHP_CodeSniffer rulesets which the [PHPCompatibility organisation](https://github.com/PHPCompatibility) maintains, in one go using Composer.
77

88

99
## What's included in this package ?
1010

1111
### Base ruleset
1212

13-
- [![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.
13+
- [![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.
1414

1515
### Framework/CMS specific rulesets
1616

@@ -45,7 +45,7 @@ Next, run:
4545
```bash
4646
vendor/bin/phpcs -i
4747
```
48-
If all went well, you will now see that the PHPCompatibility, PHPCompatibilityJoomla and PHPCompatibilityWP standards are installed for PHP_CodeSniffer.
48+
If all went well, you will now see that the `PHPCompatibility`, `PHPCompatibilityJoomla` and `PHPCompatibilityWP` standards are installed for PHP_CodeSniffer.
4949

5050

5151
## How to use
@@ -60,16 +60,18 @@ Now you can use any of the following commands to inspect your code:
6060
By default, you will only receive notifications about deprecated and/or removed PHP features.
6161

6262
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.
63-
- You can run the checks for just one specific PHP version by adding `--runtime-set testVersion 5.5` to your command line command.
64-
- 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`.
65-
- 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.
63+
64+
* You can run the checks for just one specific PHP version by adding `--runtime-set testVersion 5.5` to your command line command.
65+
* 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`.
66+
* 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.
6667

6768
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.
6869

6970

7071
## License
7172

72-
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
73+
All code within the PHPCompatibility organisation is released under the GNU Lesser General Public License (LGPL).
74+
For more information, visit https://www.gnu.org/copyleft/lesser.html
7375

7476

7577
## Changelog

0 commit comments

Comments
 (0)