Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add mention of Composer and PHP compatibility to project README. #132

Merged
merged 2 commits into from Jun 13, 2021
Merged

Add mention of Composer and PHP compatibility to project README. #132

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b246d43
Add mention of Composer and PHP compatibility to project README.
Potherca Jan 31, 2021
d924e89
Change wording based on review.
Potherca Jun 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Expand Up @@ -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:
Expand All @@ -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.
Potherca marked this conversation as resolved.
Show resolved Hide resolved

### How it works

Basically, this plugin executes the following steps:
Expand Down