README.txt in ronin-0.1.1 vs README.txt in ronin-0.1.2
- old
+ new
@@ -1,9 +1,11 @@
= Ronin
* http://ronin.rubyforge.org/
-* Postmodern Modulus III
+* http://github.com/postmodern/ronin
+* irc.freenode.net ##ronin
+* Postmodern (postmodern.mod3 at gmail.com)
== DESCRIPTION:
Ronin is a Ruby platform designed for information security and data
exploration tasks. Ronin allows for the rapid development and distribution
@@ -17,13 +19,13 @@
snake-oil solutions, give private training classes or later turn Ronin into
commercial software.
=== Modular
-Ronin was not designed as one monolithic library but instead as a collection
-of libraries which can be individually installed. This allows users to pick
-and choose what functionality they want in Ronin.
+Ronin was not designed as one monolithic framework but instead as a
+collection of libraries which can be individually installed. This allows
+users to pick and choose what functionality they want in Ronin.
=== Decentralized
Ronin does not have a central repository of exploits and payloads which
all developers contribute to. Instead Ronin has Overlays, repositories of
@@ -63,20 +65,46 @@
* Provides an IRB styled console with:
* Tab-completion enabled.
* Auto-indentation enabled.
* Pretty-Print loaded.
+== REQUIREMENTS:
+
+* Hpricot
+* WWW::Mechanize
+* DataMapper:
+ * dm-core >= 0.9.3
+ * data_objects >= 0.9.3
+ * do_sqlite3 >= 0.9.3
+ * dm-types >= 0.9.3
+ * dm-serializer >= 0.9.3
+ * dm-aggregates >= 0.9.3
+* reverse-require >= 0.1.2
+* R'epertoire >= 0.1.2
+
+== INSTALL:
+
+ $ sudo gem install ronin
+
== SYNOPSIS:
-* List installed Overlays:
+* Generate an Overlay:
- $ ronin ls
+ $ ronin overlay path/to/overlay/name/
+* Generate an Extension within an Overlay:
+
+ $ ronin ext path/to/overlay/extension/
+
* Install an Overlay:
$ ronin install svn://example.com/var/svn/overlay
+* List installed Overlays:
+
+ $ ronin ls
+
* Update all installed Overlays:
$ ronin up
* Update a specific Overlay:
@@ -89,26 +117,59 @@
* Start the Ronin console:
$ ronin
-== REQUIREMENTS:
+== RONIN LIBRARIES:
-* Hpricot
-* WWW::Mechanize
-* DataMapper:
- * dm-core >= 0.9.3
- * data_objects >= 0.9.3
- * do_sqlite3 >= 0.9.3
- * dm-types >= 0.9.3
- * dm-serializer >= 0.9.3
- * dm-aggregates >= 0.9.3
-* reverse-require >= 0.1.0
-* R'epertoire >= 0.1.2
+=== RONIN ASM
-== INSTALL:
+* http://ronin.rubyforge.org/libraries/asm.html
+* http://github.com/postmodern/ronin-asm
- $ sudo gem install ronin
+Ronin ASM is a Ruby library for Ronin that provides dynamic Assembly (ASM)
+generation of programs or shellcode.
+
+=== RONIN DORKS
+
+* http://ronin.rubyforge.org/libraries/dorks.html
+* http://github.com/postmodern/ronin-dorks
+
+Ronin Dorks is a Ruby library for Ronin that provides support for various
+Google (tm) Dorks functionality.
+
+=== RONIN EXPLOITS
+
+* http://ronin.rubyforge.org/libraries/exploits.html
+* http://github.com/postmodern/ronin-exploits
+
+Ronin Exploits is a Ruby library for Ronin that provides exploitation and
+payload crafting functionality.
+
+=== RONIN HTML
+
+* http://ronin.rubyforge.org/libraries/html.html
+* http://github.com/postmodern/ronin-html
+
+Ronin HTML is a Ruby library for Ronin that provides support for generating
+complex HTML/JavaScript or crafting XSS/CSRF attacks.
+
+=== RONIN SQL
+
+* http://ronin.rubyforge.org/libraries/sql.html
+* http://github.com/postmodern/ronin-sql
+
+Ronin SQL is a Ruby library for Ronin that provids support for SQL related
+security tasks, such as scanning for and exploiting SQL injections.
+
+=== RONIN PHP
+
+* http://ronin.rubyforge.org/libraries/php.html
+* http://github.com/postmodern/ronin-php
+
+Ronin PHP is a Ruby library for Ronin that provides support for PHP related
+security tasks, such as finding and exploiting Local File Inclusion (LFI)
+and Remote File Inclusion (RFI).
== LICENSE:
Ronin - A Ruby platform designed for information security and data
exploration tasks.