Skip to content

Update readme #42

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

Merged
merged 2 commits into from
Aug 24, 2016
Merged

Update readme #42

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da19360
Add CC badge to Readme
Aug 22, 2016
e9f3ce1
Add custom config example to readme
Aug 22, 2016
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Add custom config example to readme
  • Loading branch information
ABaldwinHunter committed Aug 24, 2016
commit e9f3ce11193c8559685730abf86db62fc33165e4
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ PHP_CodeSniffer helps you detect violations of a defined coding standard.
Format the values for these config options per the [PHP_CodeSniffer documentation](https://github.com/squizlabs/PHP_CodeSniffer).

* file_extensions - This is where you can configure the file extensions for the files that you want PHP_CodeSniffer to analyze.
* standard - This is the comma delimited list of standards that you want PHP_CodeSniffer to use while analyzing your files.
* standard - This is the comma delimited list of standards that you want
PHP_CodeSniffer to use while analyzing your files. You may optionally include
a relative path to a custom phpcs ruleset.xml file.
* ignore_warnings - You can hide warnings, and only report errors with this option.
* encoding - By default, PHPCS uses ISO-8859-1. Use this to change it to your encoding, e.g. UTF-8.

Expand All @@ -30,7 +32,7 @@ Format the values for these config options per the [PHP_CodeSniffer documentatio
enabled: true
config:
file_extensions: "php,inc,lib"
standard: "PSR1,PSR2"
standard: "PSR1,PSR2,my_custom_php_ruleset.xml"
ignore_warnings: true
encoding: utf-8
ratings:
Expand Down