Added documentation.

readme.md

@@ -0,0 +1,40 @@
+# PHP Code Sniffer Standards for WordPress Development
+
+An advanced configuration of the WordPress coding standards for plugin and theme development.
+
+This ruleset is configured to support WordPress version 5.2+ and PHP version 5.6+.
+
+## Usage
+
+- Install [Composer](https://getcomposer.org/)
+- Run `composer init` to setup Composer for your project.
+- Run `composer require wpscholar/phpcs-standards-wpscholar` to install the coding standards.
+- Run `vendor/bin/phpcs . --standard=WPScholar` from your project root to check your code.
+- Optionally, add a script to your `composer.json` file so you can just run `composer run lint` to check your code.
+
+```json
+"scripts": {
+  "lint": [
+    "vendor/bin/phpcs . --standard=WPScholar"
+  ]
+}
+```
+
+## Additional Notes
+- Append the `-s` flag to see the internal names of the rules.
+- Add `--runtime-set testVersion 5.2-` to check PHP version 5.2 or greater.
+- Add a custom `phpcs.xml` file to your project to customize the ruleset or your desired configuration.
+
+```xml
+<?xml version="1.0"?>
+<ruleset name="Project Rules">
+  <rule ref="WPScholar" />
+  <config name="testVersion" value="5.2-"/>
+  <config name="minimum_supported_wp_version" value="4.7"/>
+</ruleset>
+```
+
+### Additional Documentation
+- https://github.com/squizlabs/PHP_CodeSniffer
+- https://github.com/PHPCompatibility/PHPCompatibilityWP
+- https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards