README.rdoc in tailor-0.1.2 vs README.rdoc in tailor-0.1.3

- old
+ new

@@ -8,11 +8,13 @@ style. Rules for judging style are based on a number of style guides that are popular in the Ruby community. More on this here http://wiki.github.com/turboladen/tailor. == FEATURES/PROBLEMS: -* Recursively checks for bad style in Ruby files in a directory +* Checks for bad style in Ruby files + * Recursively in a directory, or... + * A given file * Checks for: * Indentation * Hard-tabs in indentation * Name cases * Snake case class & module names @@ -28,18 +30,26 @@ * Line length * Should be <= 80 characters == SYNOPSIS: - FIX (code sample of usage) +Run tailor like: + $ tailor path/to/check/ +...or... + $ tail file_to_check.rb + +There are a number of false-positives and false-negatives in detection of the +above rules, so please don't expect perfection in this detection. :) I'm +working on solving this. + == REQUIREMENTS: * Ruby 1.8.7 or 1.9.1 (haven't tested on others) == INSTALL: -* (sudo) gem install tailor + $ (sudo) gem install tailor == LICENSE: (The MIT License) \ No newline at end of file