Update README.md

README.md

@@ -1,2 +1,54 @@
 # AutoSploit
-Automated Mass Exploiter
+
+As the name might suggest AutoSploit attempts to automate the exploitation of remote hosts. Targets are collected automatically as well by employing the Shodan.io API. The program allows the user to enter their platform specific search query such as; 'Apache', 'IIS', etc, upon which a list of candidates will be retrieved.                           
+
+After this operation has been completed the 'Exploit' component of the program will go about the business of attempting to exploit these targets by running a series of Metasploit modules against them. Which Metasploit modules will be employed in this manner is determined by programatically comparing the name of the module to the initial search query. However, I have added functionality to run all available modules against the targets in a 'Hail Mary' type of attack.
+
+The available Metasploit modules have been selected to facilitate Remote Code Execution and to attempt to gain Reverse TCP Shells and/or Meterpreter sessions. Workspace, local host and local port for MSF facilitated back connections are configured through the dialog that comes up before the 'Exploit' component is started.
+
+*Operational Security Consideration*
+Receiving back connections on your local machine might not be the best idea from an OPSEC standpoint. Instead consider running this tool from a VPS that has all the dependencies required, available.
+
+## Usage
+
+Clone the repo.
+`https://github.com/NullArray/AutoSploit.git`
+
+After which it can be started from the terminal with `python autosploit.py`. After which you can select one of five actions. Please see the option summary below.
+```
++------------------+----------------------------------------------------+
+|     Option       |                   Summary                          |
++------------------+----------------------------------------------------+
+|1. Usage          | Display this informational message.                |
+|2. Gather Hosts   | Query Shodan for a list of platform specific IPs.  |
+|3. View Hosts     | Print gathered IPs/RHOSTS.                         |
+|4. Exploit        | Configure MSF and Start exploiting gathered targets|
+|5. Quit           | Exits AutoSploit.                                  |
++------------------+----------------------------------------------------+
+```
+## Available Modules
+The Metasploit modules available with this tool are selected for RCE. You can find them in the `modules.txt` file that is included in this repo. Should you wish to add more or other modules please do so in the following format.
+```
+use exploit/linux/http/netgear_wnr2000_rce;exploit -j; 
+```
+With each new module on it's own line.
+
+## Dependencies
+AutoSploit depends on the following Python2.7 modules.
+```
+shodan
+blessings
+```
+Should you find you do not have these installed get them with pip like so.
+```
+pip install shodan
+pip install blessings
+```
+Since the program invokes functionality from the Metasploit Framework you need to have this installed get it from Rapid7 by clicking (here)[https://www.rapid7.com/products/metasploit/].
+
+### Note
+While this isn't exactly a Beta release it is an early release nonetheless as such the tool might be subject to changes in the future. If you happen to encounter a bug or would like to contribute to the tool's improvement please feel free to (Open a Ticket)[https://github.com/NullArray/AutoSploit/issues] or (Submit a Pull Request)[https://github.com/NullArray/AutoSploit/pulls]
+
+Thanks.
+
+