README.md in churn-0.0.34 vs README.md in churn-0.0.35

@@ -2,11 +2,11 @@
 ===
 
 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)
+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.
 
 ####Authors:
 * danmayer
@@ -36,28 +36,31 @@
 * rake:
   * add `require 'churn'` to Rakefile
   * then run`rake churn` or `bundle exec rake churn`
   * use environment variables to control churn defaults
 
+      ``` ruby
         ENV['CHURN_MINIMUM_CHURN_COUNT']
         ENV['CHURN_START_DATE']
         ENV['CHURN_IGNORE_FILES']
+      ```
 
 * 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
         churn --start_date "6 months ago" #Start looking at file changes from 6 months ago
         churn -p "4 months ago" #churn the past history to build up data for the last 4 months
         churn --past_history #churn the past history for default 3 months to build up data
+      ```
 
-
 ## Example Output
 
     **********************************************************************
     * Revision Changes
     **********************************************************************
@@ -122,11 +125,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
+## CLI Options
 
     [~/projects/churn] churn -h
     NAME
       churn
 
@@ -140,9 +143,26 @@
       --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,
+      :start_date => params['start_date'].value,
+      :data_directory => params['data_directory'].value,
+      :history => params['past_history'].value,
+      :report => params['report'].value,
+      :name => params['name'].value
+    }
+    result = Churn::ChurnCalculator.new(options).report(false)
 
 ## Notes on Patches/Pull Requests
 
 * Fork the project.
 * Make your feature addition or bug fix.