diff --git a/README.md b/README.md index 9ce5bb2..64cdd49 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # Nmap-XML-Parser Converts Nmap XML output to csv file, and other useful functions + +## Usage + +### Convert Nmap output to csv file +`python3 nmap_xml_parser.py -f nmap_scan.xml -csv nmap_scan.csv` + +### Display scan information to the terminal +`python3 nmap_xml_parser.py -f nmap_scan.xml -p` + +### Display only IP addresses +`python3 nmap_xml_parser.py -f nmap_scan.xml -ip` + +### Display least common open ports +> Displays the 10 least common open ports +`python3 nmap_xml_parser.py -f nmap_scan.xml -lc 10` + +### Display most common open ports +> Displays the 10 most common open ports +`python3 nmap_xml_parser.py -f nmap_scan.xml -mc 10`