From 1aedc4e0358f3a9afc78cbaf7d7ae1fcbe2ff86e Mon Sep 17 00:00:00 2001 From: pucherot Date: Tue, 5 Jan 2021 21:50:37 +0100 Subject: [PATCH] Doc --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 1d7cd951..1ea66bf1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ # Pi.Alert - + WIFI / LAN intruder detector. -Check the devices connected to your WIFI / LAN and alert you the unknown -devices. It also warns of the disconnection of "always connected" devices. +Scan the devices connected to your WIFI / LAN and alert you the connection of +unknown devices. It also warns of the disconnection of "always connected" +devices. *(Apologies for my english and my limited knowledge of Python, php and JavaScript)* @@ -51,16 +52,16 @@ The system consists of two parts: # Installation - + Initially designed to run on a Raspberry PI, it can run on many other Linux distributions. ## Dependencies - Lighttpd (probably works on other webservers / not tested) - - arp-scan (Required for Scan Method 1) + - arp-scan (required for Scan Method 1) - Pi.hole (optional. Scan Method 2. Check devices doing DNS queries) - dnsmasq (optional. Scan Method 3. Check devices using DHCP server) - - IEEE HW Vendors Database (Necessary to identified HW vendor) + - IEEE HW Vendors Database (necessary to identified Device vendor) ## Installation process ``` @@ -71,7 +72,7 @@ Pending explain the installation process ## Other useful info - + ### Powered by: - Python (Programming language for the Back) @@ -83,7 +84,7 @@ Pending explain the installation process - Sqlite (DB engine) - Lighttpd (Webserver) - arp-scan (Scan network using arp commands) - - Pi.hole (DNS Server) + - Pi.hole (DNS Server with Ad-block) - dnsmasq (DHCP Server) ### License