Merge pull request #42 from codeclimate/abh-readme

Update readme

Author: Ashley Baldwin-Hunter

README.md

@@ -1,5 +1,7 @@
 # Code Climate PHP_CodeSniffer Engine
 
+[![Code Climate](https://codeclimate.com/github/codeclimate/codeclimate-phpcodesniffer/badges/gpa.svg)](https://codeclimate.com/github/codeclimate/codeclimate-phpcodesniffer)
+
 `codeclimate-phpcodesniffer` is a Code Climate engine that wraps the [PHP_Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer) static analysis tool. You can run it on your command line using the Code Climate CLI, or on our hosted analysis platform.
 
 PHP_CodeSniffer helps you detect violations of a defined coding standard.
@@ -15,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.
 
@@ -28,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: