Merge pull request #9 from bmitch/readme

update readme

README.md

@@ -3,6 +3,53 @@ Custom PHP Code Sniffer sniffs to help find Code Smells (Odor).
 
 [![Build Status](https://travis-ci.org/bmitch/Codor.svg?branch=master)](https://travis-ci.org/bmitch/Codor) [![codecov](https://codecov.io/gh/bmitch/Codor/branch/master/graph/badge.svg)](https://codecov.io/gh/bmitch/Codor) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/bmitch/Codor/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/bmitch/Codor/?branch=master) [![Code Climate](https://codeclimate.com/github/bmitch/Codor/badges/gpa.svg)](https://codeclimate.com/github/bmitch/Codor)
 
-
 ----------
 _Inspired by: https://github.com/object-calisthenics/phpcs-calisthenics-rules_
+
+## What is it? ##
+This package is a set of custom Sniffs for the [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer) that you can use in your CI build to ensure the ingegrity of your code base.
+
+## How to Install? ##
+
+Install via Composer:
+```
+composer require bmitch/codor --dev
+```
+
+## How to Use? ##
+Create a PHPCS ruleset XML (`codor.xml` or whatever filename you want) file in the root of your project.
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<ruleset name="Project">
+    <description>Project Coding Standard</description>
+
+    <rule ref="vendor/bmitch/codor/src/Codor/ruleset.xml"/>
+</ruleset>
+```
+
+Then run it with the command:
+```
+vendor/bin/phpcs --standard=codor.xml src 
+```
+
+Where `src` is the location of the source code you want to check.
+
+### Omitting Sniffs ###
+You may not want to run all the sniffs provided so you can specify which sniffs you want to exclude with the `--exclude` flag like:
+```
+vendor/bin/phpcs --standard=codor.xml --exclude=Codor.ControlStructures.NoElse
+```
+(if you want to exclude multiple just separate them with a comma)
+
+Or you can also specify which sniffs to specifically run:
+```
+vendor/bin/phpcs --standard=codor.xml --sniffs=Codor.ControlStructures.NoElse
+```
+
+## Sniffs Included ##
+### Codor.ControlStructures.NoElse ###
+Does not allow for any `else` or `elseif` statements.
+
+### Codor.Files.FunctionLength ###
+Functions/methods must be 20 lines of code or fewer.
+