Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updated install reqs
  • Loading branch information
skilfoy authored May 19, 2024
1 parent 83f3e69 commit 0ee2209
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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_<domain>.json`.

### Requirements

1. **API Keys**:
Expand All @@ -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_<domain>.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.
Expand Down

0 comments on commit 0ee2209

Please sign in to comment.