Permalink
Browse files

Update the readme

  • Loading branch information...
1 parent 1f1b5b2 commit 035e51335f25e69c128383ec986a8fa10d5f14ef Ben Marini committed Apr 12, 2012
Showing with 13 additions and 6 deletions.
  1. +13 −6 README.md
View
@@ -1,6 +1,7 @@
-# Health Inspector
+## Summary
-A tool to inspect your chef repo as is compares to what is on your chef server
+`health_inspector` is tool to inspect your chef repo as it compares to what is
+on your chef server.
## Usage
@@ -9,14 +10,20 @@ A tool to inspect your chef repo as is compares to what is on your chef server
Run `health_inspector help` for more options
-## What is checks
+## What it does
So far it checks if...
* your cookbooks are in sync
-* you have uncommitted changes in a cookbook (assuming your cookbooks are in their own git repos)
-* you have commits in a cookbook that haven't been pushed to your remote (assuming your cookbooks are in their own git repos)
+* you have uncommitted changes in a cookbook (assuming your cookbooks are in
+ their own git repos)
+* you have commits in a cookbook that haven't been pushed to your remote
+ (assuming your cookbooks are in their own git repos)
* your data bags are in sync
* your data bag items are in sync
* your environments are in sync
-* your roles are in sync
+* your roles are in sync
+
+## Assumptions
+
+* Your roles and environments are written using the ruby DSL.

0 comments on commit 035e513

Please sign in to comment.