Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updating readme a bit

  • Loading branch information...
commit ba2873b4b0c1098654ad03be69d20726acb1ad70 1 parent 31765b2
@qrush qrush authored
Showing with 6 additions and 7 deletions.
  1. +6 −7 README.textile
View
13 README.textile
@@ -4,27 +4,26 @@ Automatic building and reporting to campfire of metrics with metric_fu through i
h2. Features
-* Generates an entire metric_fu site for you based on your integrity projects
+* Generates metric_fu sites for each project and ties them together on one page
* Notifies campfire of metric stats given that they have changed since the last run
h2. Requirements
-* An Integrity setup.
+* integrity installed
* metric_fu
* tinder
h2. Usage
-Run @rake generate@.
+Run: @rake grade@
-It's probably best to do this on a cron job.
+Note: It's probably best to do this on a cron job.
h2. Setup
-Have a config.yml file in your report_card directory with the following info:
+Have a @config.yml@ file in your report_card directory with the following info:
<pre>
-
# This is the path to integrity's config.yml file.
integrity_config: /home/ci/integrity/config.yml
@@ -32,6 +31,7 @@ integrity_config: /home/ci/integrity/config.yml
site: /home/ci/report_card/_site
# A regular expression for project names you wish to ignore
+# You need to surround this with quotes since YAML is picky
ignore: '[^shoulda]|1\.9'
# The location of your site, for campfire reporting
@@ -41,7 +41,6 @@ url: http://metrics.thoughtbot.com
skip_notification: false
</pre>
-
h2. Thanks
To thoughtbot for supporting this project.
Please sign in to comment.
Something went wrong with that request. Please try again.