README

Berrybird PHP CodeSniffer lint rules
====================================

Current release: 0.1.0-dev


Description
-----------

PHP CodeSniffer (https://github.com/squizlabs/PHP_CodeSniffer) coding
standard rules we use at Berrybird. The coding standard is based on
PSR-2 (http://www.php-fig.org/psr/psr-2) with a couple of modifications
and additions. It also includes some quality assurance sniffs.


Installation
------------

Requirements:

 - PHP 5.3.3 or newer
 - PHP CodeSniffer

Installing using Composer:

'composer.json' definition

    "repositories": [{
        "type": "vcs",
        "url": "https://github.com/berrybird/lint-phpcs"
    }],
    "require-dev": {
        "berrybird/lint-phpcs": "dev-develop"
    }

Add Berrybird standard to the PHP CodeSniffer include paths:

    $ phpcs --config-set installed_paths /absolute/path/to/berrybird/src


Documentation
-------------

N/A


Contributing
------------

Open an issue or send a pull request on Github
(https://github.com/berrybird/lint-phpcs).


Authors
-------

Maintainer:

 - Miodrag Tokić


Copyright
---------

Copyright (C) 2014-2016 Miodrag Tokić.

Released under the MIT License. See the LICENSE file for details.

This package includes sniff classes taken from other projects. Check
corresponding files for their authors and licenses.