diff --git a/README.md b/README.md index 053f400..6dc89db 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,17 @@ Results will be dumped into the `results/$ip_address` directory, with the `$port This script is inspired by [Mike Czumak's Recon Scan](http://www.securitysift.com/offsec-pwb-oscp/), which he wrote during his OSCP exam. Many modifications can be found on GitHub, however, I wanted to write a script from scratch, familiarizing myself with each tool and their parameterization, instead of just reusing a bunch of scripts found scattered in various repositories, leaving me none the wiser. +### Installation + +Python3, python-libnmap and colorama are required. + +Install python packages: + +pip3 install python-libnmap colorama + +Run: +python3 ./recon.py -v TARGET + ### Usage usage: recon.py [-h] [-b] [-n] [-p] [-v] [-o OUTPUT] [--nmap NMAP] [--hydra HYDRA] @@ -274,4 +285,4 @@ This program is free software: you can redistribute it and/or modify it under th For more information regarding the terms and conditions of this software, please read the full legal text of the GNU General Public License version 3, a copy of which is available in the [LICENSE.md](LICENSE.md) file. Otherwise, see <>. -Some of the invoked tools are licensed under GPL or a form of GPL-derived license with added clauses further restricting how data produced by the tool can be processed, e.g. nmap. \ No newline at end of file +Some of the invoked tools are licensed under GPL or a form of GPL-derived license with added clauses further restricting how data produced by the tool can be processed, e.g. nmap.