README.md in churn-1.0.1 vs README.md in churn-1.0.2

- old
+ new

@@ -1,10 +1,10 @@ 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 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 +Churn for files is immediate, but classes and methods requires building up a history using churn between revisions. The history is stored in ./tmp Currently has full Git, Mercurial (hg), Bazaar (bzr) support, and partial SVN support (supports only file level churn currently) File changes can be calculated on any single commit to look at method changes you need to be running churn over time. Using a git post-commit hook, configuring your CI to run churn, or using [churn-site](http://churn.picoappz.com) is the best way to build up your churn history. See the --past_history (-p) option to do a one time run building up past class and method level churn. @@ -15,11 +15,11 @@ * absurdhero * bf4 ## CI Build Status -[![Build Status](https://secure.travis-ci.org/danmayer/churn.png)](http://travis-ci.org/danmayer/churn) +[![Build Status](https://travis-ci.org/danmayer/churn.svg?branch=master)](http://travis-ci.org/danmayer/churn) This project runs [travis-ci.org](http://travis-ci.org) ## TODO @@ -27,13 +27,13 @@ [![Stories in Ready](https://badge.waffle.io/danmayer/churn.png)](http://waffle.io/danmayer/churn) ## Churn Usage -Install with `gem install churn` or for bundler add to your Gemfile `gem 'churn', :require => false`. +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. +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. * rake: * add `require 'churn'` to Rakefile * then run`rake churn` or `bundle exec rake churn` * use environment variables to control churn defaults @@ -46,11 +46,11 @@ * CLI: * on command line run `churn` or `bundle exec churn` * need help run `churn -h` to get additional information * run the executable passing in options to override defaults - + ``` bash churn -i "churn.gemspec, Gemfile" #ignore files churn -y #output yaml format opposed to text churn -c 10 #set minimum churn count on a file to 10 churn -c 5 -y -i "Gemfile" #mix and match @@ -143,14 +143,14 @@ --ignore_files=[ignore_files], -i (0 ~> string(ignore_files=)) --start_date=[start_date], -s (0 ~> string(start_date=)) --data_directory=[data_directory], -d (0 ~> string(data_directory=)) --past_history=[past_history], -p (0 ~> string(past_history=)) --help, -h - + ## Library Options All the CLI options are parsed and just passed into the library. If you want to run the library directly from other code. The best way to see current options is where the [churn executable](https://github.com/danmayer/churn/blob/master/bin/churn) passes the parsed options into the `ChurnCalculator` class - + ### # Available options ### options = {:minimum_churn_count => params['minimum_churn_count'].value, :ignore_files => params['ignore_files'].value,