README.txt in roodi-1.2.0 vs README.txt in roodi-1.3.0

@@ -11,11 +11,11 @@
 * sudo gem install roodi
 
 == SYNOPSIS:
 
 To check one or more files using the default configuration that comes with Roodi, use:
-    roodi [patterns]
+    roodi [-config=file] [pattern ...]
 
 === EXAMPLE USAGE
 
 Check all ruby files in a rails app:
     roodi "rails_app/**/*.rb"
@@ -24,24 +24,52 @@
     roodi app/controller/sample_controller.rb app/models/sample.rb
 
 Check one controller and all model files in a rails app:
     roodi app/controller/sample_controller.rb "app/models/*.rb"
 
+Check all ruby files in a rails app with a custom configuration file:
+    roodi -config=my_roodi_config.yml "rails_app/**/*.rb"
 
-If you're writing a check, it is useful to see the structure of a file the way that Roodi tokenizes it (via ParesTree). Use:
+If you're writing a check, it is useful to see the structure of a file the way that Roodi tokenizes it (via ParseTree). Use:
     roodi-describe [filename]
 
+== CUSTOM CONFIGURATION
+
+To change the set of checks included, or to change the default values of the checks, you can provide your own config file.  The config file is a YAML file that lists the checks to be included.  Each check can optionally include a hash of options that are passed to the check to configure it.  For example, the default config file looks like this:
+
+    AssignmentInConditionalCheck:    { }
+    CaseMissingElseCheck:            { }
+    ClassLineCountCheck:             { line_count: 300 }
+    ClassNameCheck:                  { pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/ }
+    CyclomaticComplexityBlockCheck:  { complexity: 4 }
+    CyclomaticComplexityMethodCheck: { complexity: 8 }
+    EmptyRescueBodyCheck:            { }
+    ForLoopCheck:                    { }
+    MethodLineCountCheck:            { line_count: 20 }
+    MethodNameCheck:                 { pattern: !ruby/regexp /^[_a-z<>=\[\]|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/ }
+    ModuleLineCountCheck:            { line_count: 300 }
+    ModuleNameCheck:                 { pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/ }
+    ParameterNumberCheck:            { parameter_count: 5 }
+
 == SUPPORTED CHECKS:
 
+* AssignmentInConditionalCheck - Check for an assignment inside a conditional.  It's probably a mistaken equality comparison.
+* CaseMissingElseCheck - Check that case statements have an else statement so that all cases are covered.
+* ClassLineCountCheck - Check that the number of lines in a class is below the threshold.
 * ClassNameCheck - Check that class names match convention.
 * CyclomaticComplexityBlockCheck - Check that the cyclomatic complexity of all blocks is below the threshold.
 * CyclomaticComplexityMethodCheck - Check that the cyclomatic complexity of all methods is below the threshold.
 * EmptyRescueBodyCheck - Check that there are no empty rescue blocks.
 * ForLoopCheck - Check that for loops aren't used (Use Enumerable.each instead)
-* MethodNameCheck - Check that method names match convention.
 * MethodLineCountCheck - Check that the number of lines in a method is below the threshold.
+* MethodNameCheck - Check that method names match convention.
+* ModuleLineCountCheck - Check that the number of lines in a module is below the threshold.
 * ModuleNameCheck - Check that module names match convention.
 * ParameterNumberCheck - Check that the number of parameters on a method is below the threshold.
+
+== SUGGESTED CHECKS:
+
+* BlockVariableShadowCheck - Check that a block variable does not have the same name as a method parameter or local variable.  It may be mistakenly referenced within the block.
 
 == LICENSE:
 
 (The MIT License)