From b246d4387a82a0d7880952283e706630b00d451c Mon Sep 17 00:00:00 2001 From: Ben Peachey Date: Sun, 31 Jan 2021 12:19:03 +0100 Subject: [PATCH 1/2] Add mention of Composer and PHP compatibility to project README. --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2be42ed7..7baf3618 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,6 @@ This composer installer plugin allows for easy installation of [PHP_CodeSniffer] No more symbolic linking of directories, checking out repositories on specific locations or changing the `phpcs` configuration. -_Note: This plugin is compatible with both version 2.x and 3.x of_ [PHP_CodeSniffer][codesniffer] - ## Usage Installation can be done with [Composer][composer], by requiring this package as a development dependency: @@ -29,6 +27,14 @@ composer require --dev dealerdirect/phpcodesniffer-composer-installer That's it. +### Compatibility + +This plugin is compatible with both version **1.x** and **2.x** of [Composer][composer], and both version **2.x** and **3.x** of [PHP_CodeSniffer][codesniffer]. + +PHP **5.x**, **7.x**, and **8.x** are all supported. + +For PHP 8 version `0.7.x` (or higher) of this plugin must be _explicitly_ set as version constraints, as Composer treats minors releases below 1.0 as major releases. In other words: using `^0.6` will not allow Composer to install v0.7 and thus _not_ support PHP8. + ### How it works Basically, this plugin executes the following steps: From d924e89290ea2ec1756e4cb7e49a71ec476b734a Mon Sep 17 00:00:00 2001 From: Ben Peachey Date: Sun, 13 Jun 2021 13:09:26 +0200 Subject: [PATCH 2/2] Change wording based on review. --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7baf3618..8d4dcf48 100644 --- a/README.md +++ b/README.md @@ -29,11 +29,14 @@ That's it. ### Compatibility -This plugin is compatible with both version **1.x** and **2.x** of [Composer][composer], and both version **2.x** and **3.x** of [PHP_CodeSniffer][codesniffer]. +This plugin is compatible with: -PHP **5.x**, **7.x**, and **8.x** are all supported. +- PHP **5.x**, **7.x**, and **8.x** (Support for PHP v8 is available since [`v0.7.0`][v0.7]) +- [Composer][composer] **1.x** and **2.x** (Support for Composer v2 is available since [`v0.7.0`][v0.7]) +- [PHP_CodeSniffer][codesniffer] **2.x** and **3.x** (Support for PHP_CodeSniffer v3 is available since [`v0.4.0`][v0.4]) -For PHP 8 version `0.7.x` (or higher) of this plugin must be _explicitly_ set as version constraints, as Composer treats minors releases below 1.0 as major releases. In other words: using `^0.6` will not allow Composer to install v0.7 and thus _not_ support PHP8. + +> **ℹ️ Please Note:** [Composer treats _minor_ releases below 1.0.0 as _major_ releases][composer-manual-caret]. So version `0.7.x` (or higher) of this plugin must be _explicitly_ set as version constraint when using Composer 2.x or PHP 8.0. In other words: using `^0.6` will **not** work with Composer 2.x or PHP 8.0. ### How it works @@ -211,7 +214,7 @@ For a full list of all author and/or contributors, check [the contributors page] The MIT License (MIT) -Copyright (c) 2016-2020 Dealerdirect B.V. +Copyright (c) 2016-2021 Dealerdirect B.V. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -237,6 +240,7 @@ THE SOFTWARE. [code-of-conduct]: CODE_OF_CONDUCT.md [codesniffer]: https://github.com/squizlabs/PHP_CodeSniffer [composer-manual-scripts]: https://getcomposer.org/doc/articles/scripts.md +[composer-manual-caret]: https://getcomposer.org/doc/articles/versions.md#caret-version-range- [composer]: https://getcomposer.org/ [contributing-guidelines]: CONTRIBUTING.md [contributors]: https://github.com/Dealerdirect/phpcodesniffer-composer-installer/graphs/contributors @@ -255,3 +259,5 @@ THE SOFTWARE. [travis]: https://travis-ci.org/Dealerdirect/phpcodesniffer-composer-installer [tutorial]: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Coding-Standard-Tutorial [using-composer-plugins]: https://getcomposer.org/doc/articles/plugins.md#using-plugins +[v0.4]: https://github.com/Dealerdirect/phpcodesniffer-composer-installer/releases/tag/v0.4.0 +[v0.7]: https://github.com/Dealerdirect/phpcodesniffer-composer-installer/releases/tag/v0.7.0