Docs, bump fixes #1

guard · Feb 13, 2012 · a98487a · a98487a
1 parent 404cf4c
commit a98487a
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 7 deletions.
diff --git a/HISTORY.md b/HISTORY.md
@@ -1,3 +1,6 @@
+# 0.3.0
+- The output of guard-brakeman now uses the same code as the regular brakeman reports and uses the same options (thanks DarkTatka for the input)
+
 # 0.2.0
 - Moar better notifications
 - 'chatty' config option allows you to enter "fix mode" where ALL brakeman activity is growl'd.  Off by default, which means you are only alerted on NEW or FIXED findings

diff --git a/README.md b/README.md
@@ -50,10 +50,12 @@ Please read the [Guard documentation](http://github.com/guard/guard#readme) for
 ### List of available options
 
 ```ruby
-:notifications  => false # display Growl notifications, defaults to true
-:run_on_start   => true  # run all checks on startup, defaults to false
-:min_confidence => 3     # only alert on warnings above a threshold, defaults to 1
-:chatty         => true  # notify on ALL changes.  Defaults to false, only new or fixed warnings trigger a Growl
+:output_file    => 'donkey' # write the results to the specified file, optinally supply extension which will be used for :output_format
+:output_format  => 'html'   # specify the output format
+:notifications  => false    # display Growl notifications, defaults to true
+:run_on_start   => true     # run all checks on startup, defaults to false
+:min_confidence => 3        # only alert on warnings above a threshold, defaults to 1
+:chatty         => true     # notify on ALL changes.  Defaults to false, only new or fixed warnings trigger a Growl
 ```
 
 ## Brakeman configuration

diff --git a/guard-brakeman.gemspec b/guard-brakeman.gemspec
@@ -3,10 +3,9 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = 'guard-brakeman'
-  s.version     = '0.2.0'
+  s.version     = '0.3.0'
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Neil Matatall']
-  s.email       = ['[email protected]']
+  s.authors     = ['Neil Matatall', 'Justin Collins']
   s.homepage    = 'http://rubygems.org/gems/guard-brakeman'
   s.summary     = 'Guard gem for Brakeman'
   s.description = 'Guard::Brakeman automatically scans your Rails app for vulnerabilities'