diff --git a/README.md b/README.md index b84222e..716f024 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,35 @@ -# SkanerV2 -## Opis -Skaner V2 to kolejna odsłona naszego narzędzia do skanowania sieci lokalnej w poszukiwaniu urządzeń i otwartych portów na tych urządzeniach. Zasada działania podobna do nmap tylko napisane w pytonie, htmlu, css i js i kożystające z wygodnego interfejsu przeglądarkowego. Cały czas dodajemy do niego dodatkowe funkcje więc jak to się mówi ***"stay tuned"*** :) -## Instrukcje użytkowania +# NetworkScanner -### 1. Zainstaluj potrzebne pakiety do pythona: +![Version](https://img.shields.io/badge/version-2.0.0-blue.svg) +![Language](https://img.shields.io/badge/python-3.x-yellow.svg) +![Interface](https://img.shields.io/badge/interface-Web_UI-green.svg) +![Status](https://img.shields.io/badge/status-Active_Development-orange.svg) + +## 📝 Description +**Network Scanner** is the next iteration of our local network scanning tool, designed to discover devices and open ports within your LAN. It works similarly to `nmap` but is built with Python, HTML, CSS, and JS, featuring a convenient and modern **web-based interface**. + +We are constantly adding new features, so as they say: ***"stay tuned"***! :) + +--- + +## 🚀 Installation & Usage + +### 1. Install required Python packages +Note: Only external libraries need installation (`threading` and `socket` are built-in). +```bash +pip install flask requests ``` -pip install flask threading requests sockets + +### 2. Download and extract the source code +### 3. Navigate to the project directory +### 4. Run the application + +```bash +python ./main.py ``` -### 2. Pobierz i rozpakuj plik z kodem -### 3. Przejdź do katalogu z kodem -### 4. Uruchom kod -``` -python main.py -``` -### 5. Przejdź do [interfejsu sieciowego](http://127.0.0.1:5000) -### 6. Kliknij "Skanuj sieć" +### 5. Access the Web Interface +Open your browser and go to: +👉 http://127.0.0.1:5000 + +### 6. Start Scanning +Click the "Scan Network" button in the dashboard to begin discovery. \ No newline at end of file