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

Docs: Updated README. … #31

Merged
merged 1 commit into from
May 11, 2017
Merged

Docs: Updated README. … #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Dealerdirect: PHP_CodeSniffer Standards Composer Installer Plugin
# PHP_CodeSniffer Standards Composer Installer Plugin

![Project Stage][project-stage-shield]
![Maintenance][maintenance-shield]
![Awesome][awesome-shield]
[![License][license-shield]](LICENSE.md)

[![Travis][travis-shield]][travis]
[![Scrutinizer][scrutinizer-shield]][scrutinizer]
[![Dependency Status][versioneye-shield]][versioneye]
[![Latest Version on Packagist][packagist-version-shield]][packagist-version]
Expand All @@ -25,6 +26,16 @@ Installation can be done with [composer], by requiring this package as a develop
composer require --dev dealerdirect/phpcodesniffer-composer-installer frenck/php-compatibility
```

That's it.

### How it works

Basically this plugin executes the following steps:

- This plugin search for `phpcodesniffer-standard` packages in all of your currently installed Composer packages.
- Matching packages and the project itself are scanned for PHP_CodeSniffer rulesets.
- The plugin will call PHP_CodeSniffer and configure the `installed_paths` option.

### Calling the plugin directly

In some circumstances it is desirable to call this plugin's functionality
Expand Down Expand Up @@ -97,6 +108,11 @@ Requirements:
* Each standard can have a separate directory no deeper than 3 levels from the repository root.
* The package `type` must be `phpcodesniffer-standard`. Without this, the plugin will not trigger.

## Changelog

This repository does not contain a `CHANGELOG.md` file, however, we do publish a changelog on each release
using the [GitHub releases](changelog) functionality.

## Contributing

This is an active open-source project. We are always open to people who want to
Expand Down Expand Up @@ -149,6 +165,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

[awesome-shield]: https://img.shields.io/badge/awesome%3F-yes-brightgreen.svg
[changelog]: https://github.com/DealerDirect/phpcodesniffer-composer-installer/releases
[composer]: https://getcomposer.org/
[composer-manual-scripts]: https://getcomposer.org/doc/articles/scripts.md
[codesniffer]: https://github.com/squizlabs/PHP_CodeSniffer
Expand All @@ -166,6 +183,8 @@ THE SOFTWARE.
[project-stage-shield]: https://img.shields.io/badge/Project%20Stage-Development-yellowgreen.svg
[scrutinizer-shield]: https://img.shields.io/scrutinizer/g/DealerDirect/phpcodesniffer-composer-installer.svg
[scrutinizer]: https://scrutinizer-ci.com/g/DealerDirect/phpcodesniffer-composer-installer/
[travis-shield]: https://img.shields.io/travis/DealerDirect/phpcodesniffer-composer-installer.svg
[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
[vacancies]: http://workingatdealerdirect.eu/?post_type=vacancy&s=&department=99
Expand Down