README.md in churn-0.0.29 vs README.md in churn-0.0.30
- old
+ new
@@ -1,6 +1,7 @@
-__churn__
+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
Currently has full Git, Mercurial (hg), and Bazaar (bzr) support, and partial SVN support (supports only file level churn currently)
@@ -11,17 +12,18 @@
* ajwalters
* cldwalker
* absurdhero
* bf4
-__CI Build Status__
+## CI Build Status
[](http://travis-ci.org/danmayer/churn)
This project runs [travis-ci.org](http://travis-ci.org)
-__Churn Usage__
+## Churn Usage
+
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:
@@ -43,11 +45,11 @@
churn -c 10 #set minimum churn count on a file to 10
churn -c 5 -y -i "Gemfile" #mix and match
churn --start_date "6 months ago" #Start looking at file changes from 6 months ago
-__Example Output__
+## Example Output
**********************************************************************
* Revision Changes
**********************************************************************
Files:
@@ -111,11 +113,11 @@
| lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#initialize | 1 |
| lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#filters | 1 |
| lib/churn/churn_calculator.rb | ChurnCalculator | ChurnCalculator#to_s | 1 |
+-------------------------------+-----------------+-----------------------------------------+---------------+
-__Options__
+## Options
[~/projects/churn] churn -h
NAME
churn
@@ -127,32 +129,25 @@
--yaml, -y
--ignore_files=[ignore_files], -i (0 ~> string(ignore_files=))
--start_date=[start_date], -s (0 ~> string(start_date=))
--help, -h
-__TODO:__
+## TODO
-* SVN only supports file, add full SVN support (method and line numbers)
-* add support for cvs, and darcs
-* make storage directory configurable instead of using tmp
-* allow passing in directories to churn
-* add a filter that allows for other files besides. *.rb to get method/class checks
-* improve line number matching for Ruby files
-* add line number matching for other langauges
-* finish adding better documenation using YARD
-* rake task for building manpage (currently manually run `ronn -b1 README.rdoc`)
-* don't output methods and classes on a commit that has none detected (css and view only commits, etc)
+The list of items has been moved to the [churn wafflie.io](http://waffle.io/danmayer/churn)
-__Notes on Patches/Pull Requests__
+[](http://waffle.io/danmayer/churn)
+## Notes on Patches/Pull Requests
+
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with rakefile, version, or history.
(if you want to have your own version, that is fine but
bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
-__Copyright__
+## Copyright
Copyright (c) 2013 Dan Mayer. See LICENSE for details.