Skip to content

Commit 7d88491

Browse files
authored
Enhance README with multilingual support and formatting
Updated README to include German translation and improved formatting.
1 parent f503a4f commit 7d88491

1 file changed

Lines changed: 97 additions & 2 deletions

File tree

README.md

Lines changed: 97 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,97 @@
1-
# URL-Reputation-Analyzer
2-
The URL Reputation Analyzer is a local-first tool for analyzing and evaluating URLs. It helps users securely verify suspicious or unknown links – fully offline or optionally using APIs such as VirusTotal.
1+
# 🌐 URL Reputation Analyzer
2+
3+
|<img width="1280" height="640" alt="logo" src="https://github.com/user-attachments/assets/c296be1b-1bcf-41e6-8b9c-ac2f61f1f39a" />|
4+
|---|
5+
6+
Ein leistungsstarkes, lokal arbeitendes Tool zur Analyse und Bewertung von URLs.
7+
Es hilft dabei, verdächtige oder unbekannte Links sicher zu überprüfen – komplett offline oder optional mit API-Anbindung (z. B. VirusTotal).
8+
9+
---
10+
11+
## German
12+
13+
### 🧩 Übersicht
14+
Der **URL Reputation Analyzer** wurde entwickelt, um Administratoren, Forensikern und Entwicklern eine einfache Möglichkeit zu geben, URLs auf potenzielle Risiken zu überprüfen.
15+
Die Anwendung kann Domains extrahieren, DNS- und WHOIS-Abfragen durchführen und lokale Hashvergleiche bekannter bösartiger Domains vornehmen.
16+
Optional kann sie über die VirusTotal API erweitert werden.
17+
18+
### 🛠 Funktionen
19+
- Analyse verdächtiger URLs (lokal/offline)
20+
- WHOIS- und DNS-Abfragen
21+
- Hash-Vergleich mit bekannter Malware-Liste
22+
- IP- und Geoinformationen
23+
- Optional: VirusTotal-Integration via API-Key (`config.py`)
24+
- Mehrsprachig (Deutsch/Englisch)
25+
- GUI mit Info-Button und GitHub-Link
26+
27+
### ⚙️ Systemanforderungen
28+
- **Python 3.10 oder höher**
29+
- Erforderliche Pakete:
30+
31+
```bash
32+
pip install requests dnspython python-whois geocoder
33+
```
34+
35+
### ▶️ Ausführen
36+
```bash
37+
python app.py
38+
```
39+
40+
### 🔑 API-Integration
41+
1. Lege eine Datei `config.py` im Projektverzeichnis an.
42+
2. Trage deinen API-Key ein:
43+
```python
44+
VT_API_KEY = "DEIN_API_KEY_HIER"
45+
```
46+
3. Wenn kein Key vorhanden ist, arbeitet das Tool automatisch offline.
47+
48+
### 📜 Lizenz
49+
Dieses Projekt steht unter der **MIT-Lizenz**.
50+
51+
<br>
52+
53+
---
54+
55+
<br>
56+
57+
## English
58+
59+
### 🧩 Overview
60+
The **URL Reputation Analyzer** is a local-first tool for analyzing and evaluating URLs.
61+
It helps users securely verify suspicious or unknown links – fully offline or optionally using APIs such as VirusTotal.
62+
63+
### 🛠 Features
64+
- Local/offline URL analysis
65+
- WHOIS and DNS lookups
66+
- Hash comparison with known malicious domains
67+
- IP and geolocation information
68+
- Optional VirusTotal integration via API key (`config.py`)
69+
- Dual-language support (German/English)
70+
- GUI with Info button and GitHub link
71+
72+
### ⚙️ Requirements
73+
- **Python 3.10 or higher**
74+
- Required dependencies:
75+
76+
```bash
77+
pip install requests dnspython python-whois geocoder
78+
```
79+
80+
### ▶️ Run
81+
```bash
82+
python app.py
83+
```
84+
85+
### 🔑 API Integration
86+
1. Create a `config.py` file in your project directory.
87+
2. Add your API key:
88+
```python
89+
VT_API_KEY = "YOUR_API_KEY_HERE"
90+
```
91+
3. If no key is provided, the tool automatically operates in offline mode.
92+
93+
### 📜 License
94+
This project is licensed under the **MIT License**.
95+
96+
---
97+
© 2025 – Developed with precision and security in mind.

0 commit comments

Comments
 (0)