Skip to content

Commit e4062dd

Browse files
authored
Merge pull request #64 from PHPCompatibility/feature/readme-minor-tweaks
README: minor markdown tweaks
2 parents ba3dc9b + 00a6ef5 commit e4062dd

File tree

1 file changed

+30
-16
lines changed

1 file changed

+30
-16
lines changed

README.md

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1+
# PHPCompatibilitySymfony
2+
13
[![Latest Stable Version](https://img.shields.io/packagist/v/phpcompatibility/phpcompatibility-symfony?label=stable)](https://packagist.org/packages/phpcompatibility/phpcompatibility-symfony)
24
[![Latest Unstable Version](https://img.shields.io/badge/unstable-dev--develop-e68718.svg?maxAge=2419200)](https://packagist.org/packages/phpcompatibility/phpcompatibility-symfony)
35
[![License](https://img.shields.io/github/license/PHPCompatibility/PHPCompatibilitySymfony?color=00a7a7)](https://github.com/PHPCompatibility/PHPCompatibilitySymfony/blob/master/LICENSE)
46
[![Build Status](https://github.com/PHPCompatibility/PHPCompatibilitySymfony/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/PHPCompatibility/PHPCompatibilitySymfony/actions/workflows/ci.yml)
57

6-
# PHPCompatibilitySymfony
7-
88
Using PHPCompatibilitySymfony, you can analyse the codebase of a project using any of the [Symfony polyfill libraries](https://github.com/symfony?utf8=?&q=polyfill), for PHP cross-version compatibility.
99

1010

@@ -14,17 +14,17 @@ A set of rulesets for PHP_CodeSniffer to check for PHP cross-version compatibili
1414

1515
These rulesets prevent false positives from the [PHPCompatibility standard](https://github.com/PHPCompatibility/PHPCompatibility) by excluding back-fills and poly-fills which are provided by those libraries.
1616

17-
Symfony Polyfill Library | Corresponding PHPCompatibility Ruleset | Includes
18-
--- | --- | ---
19-
[`polyfill-php54`](https://github.com/symfony/polyfill-php54) | `PHPCompatibilitySymfonyPolyfillPHP54` |
20-
[`polyfill-php55`](https://github.com/symfony/polyfill-php55) | `PHPCompatibilitySymfonyPolyfillPHP55` | [`PHPCompatibilityPasswordCompat`](https://github.com/PHPCompatibility/PHPCompatibilityPasswordCompat)
21-
[`polyfill-php56`](https://github.com/symfony/polyfill-php56) | `PHPCompatibilitySymfonyPolyfillPHP56` |
22-
[`polyfill-php70`](https://github.com/symfony/polyfill-php70) | `PHPCompatibilitySymfonyPolyfillPHP70` | [`PHPCompatibilityParagonieRandomCompat`](https://github.com/PHPCompatibility/PHPCompatibilityParagonie)
23-
[`polyfill-php71`](https://github.com/symfony/polyfill-php71) | `PHPCompatibilitySymfonyPolyfillPHP71` |
24-
[`polyfill-php72`](https://github.com/symfony/polyfill-php72) | `PHPCompatibilitySymfonyPolyfillPHP72` |
25-
[`polyfill-php73`](https://github.com/symfony/polyfill-php73) | `PHPCompatibilitySymfonyPolyfillPHP73` |
26-
[`polyfill-php74`](https://github.com/symfony/polyfill-php74) | `PHPCompatibilitySymfonyPolyfillPHP74` |
27-
[`polyfill-php80`](https://github.com/symfony/polyfill-php80) | `PHPCompatibilitySymfonyPolyfillPHP80` |
17+
| Symfony Polyfill Library | Corresponding PHPCompatibility Ruleset | Includes |
18+
|--------------------------|----------------------------------------|-------------------------------------------|
19+
| [`polyfill-php54`] | `PHPCompatibilitySymfonyPolyfillPHP54` | |
20+
| [`polyfill-php55`] | `PHPCompatibilitySymfonyPolyfillPHP55` | [`PHPCompatibilityPasswordCompat`] |
21+
| [`polyfill-php56`] | `PHPCompatibilitySymfonyPolyfillPHP56` | |
22+
| [`polyfill-php70`] | `PHPCompatibilitySymfonyPolyfillPHP70` | [`PHPCompatibilityParagonieRandomCompat`] |
23+
| [`polyfill-php71`] | `PHPCompatibilitySymfonyPolyfillPHP71` | |
24+
| [`polyfill-php72`] | `PHPCompatibilitySymfonyPolyfillPHP72` | |
25+
| [`polyfill-php73`] | `PHPCompatibilitySymfonyPolyfillPHP73` | |
26+
| [`polyfill-php74`] | `PHPCompatibilitySymfonyPolyfillPHP74` | |
27+
| [`polyfill-php80`] | `PHPCompatibilitySymfonyPolyfillPHP80` | |
2828

2929
> About "Includes":
3030
> Some polyfills have other polyfills as dependencies. If the PHPCompatibility project offers a dedicated ruleset for the polyfill dependency, that ruleset will be included in the ruleset for the higher level polyfill.
@@ -38,8 +38,8 @@ Symfony Polyfill Library | Corresponding PHPCompatibility Ruleset | Includes
3838
## Requirements
3939

4040
* [PHP_CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer).
41-
* PHP 5.3+ for use with [PHP_CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer) 2.3.0+.
42-
* PHP 5.4+ for use with [PHP_CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer) 3.0.2+.
41+
- PHP 5.3+ for use with [PHP_CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer) 2.3.0+.
42+
- PHP 5.4+ for use with [PHP_CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer) 3.0.2+.
4343

4444
Use the latest stable release of PHP_CodeSniffer for the best results.
4545
The minimum _recommended_ version of PHP_CodeSniffer is version 2.6.0.
@@ -113,4 +113,18 @@ By default PHP_CodeSniffer will analyse PHP, JavaScript and CSS files. As the PH
113113

114114
## License
115115

116-
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
116+
All code within the PHPCompatibility organisation is released under the GNU Lesser General Public License (LGPL). For more information, visit <https://www.gnu.org/licenses/lgpl-3.0.html>.
117+
118+
119+
[`PHPCompatibilityPasswordCompat`]: https://github.com/PHPCompatibility/PHPCompatibilityPasswordCompat
120+
[`PHPCompatibilityParagonieRandomCompat`]: https://github.com/PHPCompatibility/PHPCompatibilityParagonie
121+
122+
[`polyfill-php54`]: https://github.com/symfony/polyfill-php54
123+
[`polyfill-php55`]: https://github.com/symfony/polyfill-php55
124+
[`polyfill-php56`]: https://github.com/symfony/polyfill-php56
125+
[`polyfill-php70`]: https://github.com/symfony/polyfill-php70
126+
[`polyfill-php71`]: https://github.com/symfony/polyfill-php71
127+
[`polyfill-php72`]: https://github.com/symfony/polyfill-php72
128+
[`polyfill-php73`]: https://github.com/symfony/polyfill-php73
129+
[`polyfill-php74`]: https://github.com/symfony/polyfill-php74
130+
[`polyfill-php80`]: https://github.com/symfony/polyfill-php80

0 commit comments

Comments
 (0)