diff --git a/README.md b/README.md index c13ee65e51db0ea3f0bc426dbcabcbd179dd1449..89aa706cb831b0c190db485f2ef33ea9d27da5c6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # netscan -# Scans the specified network to find and list alive nodes. +Scans the specified network to find and list alive nodes. + + Syntax: /usr/bin/python netscan.py [-n Network -p Port -f FilePath ] ... + + example: /usr/bin/python netscan.py -n 192.168.1.0/24 -p 22 -f /etc/output.json + /usr/bin/python netscan.py -n 192.168.1.16/30,192.168.2.2/32 -p 22 -f /etc/output.json + + args: + -h --help Help. + -v --version Shows version. + -n --network Network(S) to scan. + -f --file-path File path containing file name to save the output. + You can write the output in .csv, .txt or .json file formats. + + © 2023 Hamid Sadeghian +