Update README.md
Browse files
README.md
CHANGED
|
@@ -10,4 +10,46 @@ pinned: false
|
|
| 10 |
license: mit
|
| 11 |
---
|
| 12 |
|
| 13 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 10 |
license: mit
|
| 11 |
---
|
| 12 |
|
| 13 |
+
# OSINT Tool 🏢
|
| 14 |
+
|
| 15 |
+
An open-source intelligence (OSINT) tool designed to gather and analyze information from various sources.
|
| 16 |
+
|
| 17 |
+

|
| 18 |
+

|
| 19 |
+

|
| 20 |
+
|
| 21 |
+
## Features
|
| 22 |
+
|
| 23 |
+
- **Multi-threaded Scanning**: Efficiently scans multiple sources concurrently.
|
| 24 |
+
- **Data Processing**: Extracts and processes valuable information using regular expressions.
|
| 25 |
+
- **Reporting**: Generates comprehensive reports in JSON and CSV formats.
|
| 26 |
+
- **User Interface**: Interactive interface built with Streamlit for easy interaction.
|
| 27 |
+
|
| 28 |
+
## Setup
|
| 29 |
+
|
| 30 |
+
1. Clone the repository:
|
| 31 |
+
|
| 32 |
+
```bash
|
| 33 |
+
git clone https://github.com/your-username/osint-tool.git
|
| 34 |
+
cd osint-tool
|
| 35 |
+
```
|
| 36 |
+
|
| 37 |
+
2. Install the required dependencies:
|
| 38 |
+
|
| 39 |
+
```bash
|
| 40 |
+
pip install -r requirements.txt
|
| 41 |
+
```
|
| 42 |
+
|
| 43 |
+
3. Run the Streamlit app:
|
| 44 |
+
|
| 45 |
+
```bash
|
| 46 |
+
streamlit run app.py
|
| 47 |
+
```
|
| 48 |
+
|
| 49 |
+
## Contributing
|
| 50 |
+
|
| 51 |
+
Contributions are welcome! Please fork the repository and submit a pull request with your proposed changes.
|
| 52 |
+
|
| 53 |
+
## License
|
| 54 |
+
|
| 55 |
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|