README.md in churn-0.0.28 vs README.md in churn-0.0.29

- old
+ new

@@ -1,26 +1,29 @@ __churn__ -A Project to give the churn file, class, and method for a project for a given checkin. Over time the tool adds up the history of chruns to give the number of times a file, class, or method is changing during the life of a project. +A Project to give the churn file, class, and method for a project for a given checkin. Over time the tool adds up the history of churns to give the number of times a file, class, or method is changing during the life of a project. Churn for files is immediate, but classes and methods requires buildings up a history using churn between revisions. The history is stored in ./tmp Currently has full Git, Mercurial (hg), and Bazaar (bzr) support, and partial SVN support (supports only file level churn currently) Authors: * danmayer * ajwalters * cldwalker * absurdhero +* bf4 __CI Build Status__ [![Build Status](https://secure.travis-ci.org/danmayer/churn.png)](http://travis-ci.org/danmayer/churn) This project runs [travis-ci.org](http://travis-ci.org) __Churn Usage__ -Install with `gem install churn` or for bundler add to your Gemfile `gem 'churn'` +Install with `gem install churn` or for bundler add to your Gemfile `gem 'churn', :require => false`. + +The reason you want require false is that when required by default churn is expecting to add some rake tasks, you don't really want or need it loading when running your server or tests. Previous versions required this change, churn will now do the right thing if you forget to add `require => false`. * rake: * add `require 'churn'` to Rakefile * then run`rake churn` or `bundle exec rake churn` * use environment variables to control churn defaults