diff --git a/README.md b/README.md index dc315c9..9be4082 100644 --- a/README.md +++ b/README.md @@ -34,18 +34,20 @@ Currently Supports - [ ] NMAP - [ ] More to come - -Setup +Getting Started =============== -```python -Install pip: -sudo install python-pip -sudo pip install --upgrade pip +1) Follow the [install requirements](#installreq) +2) Fill out the section you want to process in example.ini file +3) Modify the IP settings in the logstash files to accomodate your environment and import them to your logstash conf directory (default is /etc/logstash/conf.d/) +4) Import the kibana visualizations +5) [Run Vulnwhisperer](#run) -Manually install requirements: -sudo pip install pytz -sudo pip install pandas +Install Requirements +-------------------- + + +```python Using requirements file: sudo pip install -r /path/to/VulnWhisperer/requirements.txt @@ -68,7 +70,7 @@ There are a few configuration steps to setting up VulnWhisperer:

-Run +Run ----- To run, fill out the configuration file with your vulnerability scanner settings. Then you can execute from the command line. ```python