From 0ee220941449dcb6ff071f291be383690ead57e7 Mon Sep 17 00:00:00 2001 From: Sean Kilfoy <20802814+skilfoy@users.noreply.github.com> Date: Sun, 19 May 2024 11:25:26 -0500 Subject: [PATCH] Update README.md Updated install reqs --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d01f1a8..4fd0bf8 100644 --- a/README.md +++ b/README.md @@ -94,14 +94,6 @@ The script performs extensive Open Source Intelligence (OSINT) on a given domain 8. **Compilation of OSINT Report**: - All gathered data is compiled into a comprehensive OSINT report and saved to a JSON file. -### Example Script Execution - -To run the script, the user needs to execute it and provide the target domain when prompted: -```bash -python osint_script.py -``` -The user will be prompted to enter the target domain, and the script will then perform the OSINT activities, generating an OSINT report saved as a JSON file named `osint_report_.json`. - ### Requirements 1. **API Keys**: @@ -110,6 +102,19 @@ The user will be prompted to enter the target domain, and the script will then p 2. **Python Packages**: - Required Python packages include `requests`, `beautifulsoup4`, `python-whois`, `shodan`, `twython`, and `dnspython`. +### Required Packages + +```bash +pip install requests beautifulsoup4 python-whois shodan twython dnspython +``` +### Example Script Execution + +To run the script, the user needs to execute it and provide the target domain when prompted: +```bash +python osint_script.py +``` +The user will be prompted to enter the target domain, and the script will then perform the OSINT activities, generating an OSINT report saved as a JSON file named `osint_report_.json`. + ### Comprehensive OSINT Report The final OSINT report is a JSON file that includes detailed information from all the sources and tools mentioned, providing a thorough overview of the target domain's online presence, security posture, and potential vulnerabilities.