Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Menion .cane file in README.
  • Loading branch information
Ben Hamill committed Feb 19, 2012
1 parent 7f773cf commit c187fcf
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Expand Up @@ -31,6 +31,9 @@ Customize behaviour with a wealth of options:

> cane --help
Usage: cane [options]

You can also put these options in a .cane file.

--abc-glob GLOB Glob to run ABC metrics over (default: lib/**/*.rb)
--abc-max VALUE Report any methods with complexity greater than VALUE (default: 15)
--no-abc Disable ABC checking
Expand All @@ -49,6 +52,17 @@ Customize behaviour with a wealth of options:
--version Show version
-h, --help Show this message

Set default options into a `.cane` file.

> cat .cane
--no-doc
--abc-glob **/*.rb
> cane

It works just like this.

> cane --no-doc --abc-glob '**/*.rb'

## Adding to a legacy project

Cane can be configured to still pass in the presence of a set number of
Expand Down

0 comments on commit c187fcf

Please sign in to comment.