diff --git a/README.md b/README.md index 57f528d..126af1f 100644 --- a/README.md +++ b/README.md @@ -7,4 +7,12 @@ If you wish to use this configuration in your project, install it using composer `composer require --dev emielmolenaar/phpcs-laravel` +Afterwards, you may run `php vendor/bin/phpcs -i` and see `phpcs-laravel` listed as an installed ruleset. + +You may now use the ruleset like so: + +`php vendor/bin/phpcs --standard=phpcs-laravel my_file.php` + +_Note_, If you're installing globally with Composer you can simply do `phpcs -i`. + Contributions welcome. diff --git a/phpcs.xml b/ruleset.xml similarity index 100% rename from phpcs.xml rename to ruleset.xml