From dc388338cc5eda4f384a490cb898429a6185af29 Mon Sep 17 00:00:00 2001 From: CyberRoute Date: Thu, 19 Sep 2024 16:56:03 +0200 Subject: [PATCH] readme --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 78b2fb5..94e1152 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ # Phantom ## Overview -Phantom is an **ARP Scanner** tool that scans the network and retrieves information about devices connected to the same network. The tool provides details like IP addresses, MAC addresses, hostnames, and the manufacturers of the devices based on their MAC addresses. - +Phantom is an **ARP Scanner** mostly designed to detect directly connected IoT devices. The tool provides details like IP addresses, MAC addresses, hostnames, and the manufacturers of the devices based on their MAC addresses. The tool features a graphical user interface (GUI) built with **PySide6** (Qt framework) and utilizes **scapy** for ARP scanning. - --- ## Features @@ -43,7 +41,7 @@ Ensure the following dependencies are installed: ```bash git clone https://github.com/CyberRoute/phantom.git - cd arp-scanner + cd phantom ``` 2. **Install the dependencies with Pipenv**: @@ -106,3 +104,6 @@ Ensure the following dependencies are installed: - Press the **"Quit"** button to stop the ARP scan and close the application. +## Contribute +Fork the repo and send PRs if you like :) +