README.md in quality-8.1.1 vs README.md in quality-9.0.0

- old
+ new

@@ -8,10 +8,16 @@ Quality is a tool that runs quality checks on Ruby code using cane, reek, flog, flay and rubocop and makes sure your numbers don't get any worse over time. +## Why + +See [this post](http://blog.apiology.cc/2014/06/scalable-quality-part-1.html) or [these slides](https://docs.google.com/presentation/d/1Op4FH34-enm8luEIuAAVLkuAJ-sB4LKaMm57RJzvfeI/edit#slide) for more information on the problem the quality gem solves. + +##How to use + ```bash $ gem install quality ``` or in your Gemfile: @@ -79,13 +85,21 @@ # # Defaults to t.ruby_dirs t.source_dirs.concat(%w(MyProject MyProjectTests)) # Pick any extra files that are source files, but may not have - # extensions--defaults to ['Rakefile'] + # extensions--defaults to %w(Rakefile Dockerfile) t.extra_files = ['tools/check-script', 'Rakefile'] + # Extensions for Ruby language files--defaults to 'rb,rake' + t.ruby_file_extensions = 'rb,rake' + + # Extensions for all source files--defaults to + # 'rb,rake,swift,cpp,c,java,py,clj,cljs,scala,js,yml,sh,json' + t.source_file_extensions = + 'rb,rake,swift,cpp,c,java,py,clj,cljs,scala,js,yml,sh,json' + # Relative path to output directory where *_high_water_mark # files will be read/written # # Defaults to 'metrics' t.output_dir = 'metrics' @@ -96,14 +110,10 @@ # Defaults to 'XXX|TODO' t.punchlist_regexp = 'XXX|TODO' } ``` -## Why - -See [this post for more information](http://blog.apiology.cc/2014/06/scalable-quality-part-1.html) on the problem the quality gem solves. - ## Code coverage You can pull a similar trick with code coverage using SimpleCov in Ruby--put 'simplecov' in your Gemfile, and add the code below into your test_helper.rb or spec_helper.rb. ``` @@ -118,10 +128,10 @@ Quality uses [semantic versioning](http://semver.org/)--any incompatible changes will come out as major number updates. ## Supported Ruby Versions -Tested against Ruby 1.9.3 and 2.1.2. Feel free to submit issues if problems are found elsewhere. +Tested against Ruby >=2.0--does not support Ruby 1.9.x. ## Contributing * Fork the repo * Create a feature branch