Permalink
Browse files

Words

  • Loading branch information...
iain committed Feb 13, 2012
1 parent f15f3e4 commit 16d1ebe5b0c07b9dd37e3bfad55399873c32bd89
Showing with 17 additions and 6 deletions.
  1. +17 −6 README.md
View
@@ -24,18 +24,14 @@ loading RSpec.
## Usage
-Install:
+Install it:
gem install metrical
-Run:
+And run it:
metrical
-To get help:
-
- metrical --help
-
## Configuration
You can configure MetricFu in a `.metrics` file in the root of your project.
@@ -47,6 +43,21 @@ You can configure MetricFu in a `.metrics` file in the root of your project.
For more information on configuring your metrics, please visit the
[MetricFu homepage](http://metric-fu.rubyforge.org/).
+You can also turn off metrics when running, for instance:
+
+ metrical --no-rcov
+
+The metrics you can turn on and off depend on the type of project you are in.
+For instance, Rails projects also have `rails_best_practices` and `stats` as
+options.
+
+Also, Metrical tries to be smart about your Ruby version. Some metrics are not
+available on Ruby 1.9 and are disabled automatically.
+
+To see which metrics are available, run:
+
+ metrical --help
+
And that's all there is too it. If you have any suggestions, ideas or bug fixes,
please drop me a line, or make a github issue.

0 comments on commit 16d1ebe

Please sign in to comment.