diff --git a/README.md b/README.md index 205f102..f920143 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

-VulnWhisperer is a vulnerability report aggregator for nessus (more scanners to come). VulnWHisperer will pull all the reports +VulnWhisperer is a vulnerability report aggregator for nessus (more scanners to come). VulnWhisperer will pull all the reports and create a file with a unique filename which is then fed into logstash. Logstash extracts data from the filename and tags all of the information inside the report (see logstash_vulnwhisp.conf file). Data is then shipped to elasticsearch to be indexed. @@ -19,6 +19,14 @@ sudo pip install -r requirements.txt python setup.py install ``` +Requirements +------------- +#### +* ElasticStack +* Python 2.7 +* Vulnerability Scanner - (Nessus) +* Optional: Message broker such as Kafka or RabbitMQ + Currently Supports ------------- ####