diff --git a/README.md b/README.md index 0cc5604..dc798ff 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,52 @@ Extracts input (link, form, cookie, header) vectors/params from HTTP requests and exports them in a suitable format for use with [Arachni](http://arachni-scanner.com)'s VectorFeed plug-in in order to perform extremely focused audits or unit-tests. + +## Installation + +### Gemfile + +```ruby +gem 'rack-arachni-vectorfeed', :git => 'git://github.com/Arachni/rack-arachni-vectorfeed.git' +``` + +### Source + +``` +git clone git://github.com/Arachni/rack-arachni-vectorfeed.git +cd rack-arachni-vectorfeed +rake install +``` + +## Example + +You can use it in any Rack-based app like so: + +```ruby +require 'rubygems' +require 'sinatra' +require 'sinatra/contrib' + +require 'rack/arachni_vectorfeed' + +use Rack::ArachniVectorFeed, outfile: 'vectors.yml' + +get "/" do + cookies[:cookie_input] ||= 'cookie_blah' + 'hello' +end + +get "/example" do + < + + + +EOHTML +end + +post '/example' do + p params +end + +```