diff --git a/README.md b/README.md index e47c423..8a39663 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,17 @@ A threading management application that allows controlled execution of multiple commands, over multiple targets. [![Python 3.2|3.6](https://img.shields.io/badge/python-3.2|3.6-green.svg)](https://www.python.org/) [![License](https://img.shields.io/badge/license-GPL3-_red.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html) [![Build Status](https://travis-ci.org/codingo/Reconnoitre.svg?branch=master)](https://travis-ci.org/codingo/Reconnoitre) [![Twitter](https://img.shields.io/badge/twitter-@codingo__-blue.svg)](https://twitter.com/codingo_) + +# Usage + +| Argument | Description | +|------------|--------------------------------------------------------------------------------------------------------------| +| -t | Specify a target or domain name | +| -tL | Specify a list of targets or domain names | +| -threads | Specify the maximum number of threads to run at any one time (DEFAULT:5) | +| -timeout | Specify a timeout value in seconds for any one thread (DEFAULT:600) | +| -c | Specify a single command to execute over each target or domain | +| -cL | Specify a list of commands to execute over each target or domain | +| --no-color | If set then any foreground or background colours will be stripped out | +| --silent | If set then only important information will be displayed and banners and other information will be redacted. | +| -v | If set then verbose output will be displayed in the terminal |