README.md in quality-1.3.1 vs README.md in quality-2.0.0

- old
+ new

@@ -1,7 +1,9 @@ [![Build Status](https://travis-ci.org/apiology/quality.png)](https://travis-ci.org/apiology/quality) +[![Coverage Status](https://coveralls.io/repos/apiology/quality/badge.png?branch=master)](https://coveralls.io/r/apiology/quality?branch=master) + # Quality -- code quality ratchet for Ruby ##Overview Quality is a tool that runs quality checks on Ruby code using cane, @@ -10,13 +12,26 @@ ```bash $ gem install quality ``` -and add it to your Rakefile like this: +or in your Gemfile: ```ruby +group :development do + gem 'quality' +end +``` +and then: + +```bash +$ bundle install +``` + +Once you have the gem, configure your Rakefile like this: + +```ruby require 'quality/rake/task' Quality::Rake::Task.new ``` @@ -50,27 +65,41 @@ # Defaults to [] t.skip_tools = [] # Array of directory names which contain ruby files to analyze. # - # Defaults to %w{lib test spec feature}, which translates to *.rb in the base directory, as well as lib, test, spec, and feature. - t.ruby_dirs = %w{lib test spec feature} + # Defaults to %w{app lib test spec feature}, which translates to *.rb in the base directory, as well as those directories. + t.ruby_dirs = %w{app lib test spec feature} # Relative path to output directory where *_high_water_mark # files will be read/written # - # Defaults to . - t.output_dir = '.' + # Defaults to 'metrics' + t.output_dir = 'metrics' } ``` +## 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. + +## Maturity + +Quality is rapidly evolving, but 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. + ## Contributing * Fork the repo * Create a feature branch -* Submit a pull request +* Submit a github pull request +Many thanks to all contributors, especially [@andyw8](https://github.com/andyw8), who has contributed some great improvements. + ### Dependencies Quality makes use of the following other gems, which do the actual checking: * [reek](https://github.com/troessner/reek) @@ -80,5 +109,9 @@ * [rubocop](https://github.com/bbatsov/rubocop) ### Learn More * Browse the code or install the latest development version from [https://github.com/apiology/quality/tree](https://github.com/apiology/quality/tree) + +## License + +Licensed under the MIT license.