README.md in owasp_zap-0.0.1 vs README.md in owasp_zap-0.0.5
- old
+ new
@@ -1,9 +1,15 @@
# OwaspZap
-TODO: Write a gem description
+A ruby client to access the HTTP API from Zap Proxy (http://code.google.com/p/zaproxy)
+
+if you need a rpm, check it here: https://build.opensuse.org/package/show/home:vpereirabr/owasp-zap
+
+[](https://travis-ci.org/vpereira/owasp_zap)
+[](https://codeclimate.com/github/vpereira/owasp_zap)
+
## Installation
Add this line to your application's Gemfile:
gem 'owasp_zap'
@@ -16,10 +22,20 @@
$ gem install owasp_zap
## Usage
-TODO: Write usage instructions here
+ require 'owasp_zap'
+
+ include OwaspZap
+
+ z = Zap.new :target=>'http://xxx.xxx.xxx' #create new Zap instance with default params
+ z = Zap.new :target=>'http://yyy.yyy.yyy', :zap=>"/usr/share/owasp-zap/zap.sh" #if you got my obs package
+ z.start # start interactive
+ # TODO
+ # document it further :)
+ z.start :daemon=>true # start in daemon mode
+ z.shutdown # stop the proxy
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)