README.txt in ronin-scanners-0.1.1 vs README.txt in ronin-scanners-0.1.2
- old
+ new
@@ -39,19 +39,51 @@
== FEATURES/PROBLEMS:
* Provides a Rubyful interface to Nmap.
* Allows for recording of Nmap scan results using ScanDB.
+* Provides a Rubyful interface to Nikto.
== REQUIREMENTS:
-* Scandb
-* RProgram >= 0.1.4
-* Ronin >= 0.1.2
+* {scandb}[http://scandb.rubyforge.org/]
+* {rprogram}[http://rprogram.rubyforge.org/] >= 0.1.4
+* {ronin}[http://ronin.rubyforge.org/] >= 0.1.2
== INSTALL:
$ sudo gem install ronin-scanners
+
+== SYNOPSIS:
+
+* Start the Ronin console with Ronin Scanners preloaded:
+
+ $ ronin-scanners
+
+== EXAMPLES:
+
+* Calling Nmap from Ruby:
+
+ require 'ronin/scanners/nmap'
+
+ Scanners::Nmap.scan(:targets => 'www.google.com', :ports => [80,21,25], :service_scan => true)
+ # Starting Nmap 4.68 ( http://nmap.org ) at 2009-01-09 16:51 PST
+ # Interesting ports on mh-in-f99.google.com (209.85.173.99):
+ # PORT STATE SERVICE VERSION
+ # 21/tcp filtered ftp
+ # 25/tcp filtered smtp
+ # 80/tcp open http Google httpd 1.3 (GFE)
+ # Service Info: OS: Linux
+ #
+ # Service detection performed. Please report any incorrect results at http://nmap.org/submit/ .
+ # Nmap done: 1 IP address (1 host up) scanned in 11.627 seconds
+ # => nil
+
+* Calling Nikto from Ruby:
+
+ require 'ronin/scanners/nikto'
+
+ Scanners::Nikto.scan(:host => 'www.example.com')
== LICENSE:
Ronin Scanners - A Ruby library for Ronin that provides Ruby interfaces to
various third-party security scanners.