From 5e78dfcbc2eeada05f005ee493e714822ce781fc Mon Sep 17 00:00:00 2001 From: pucherot Date: Tue, 5 Jan 2021 09:37:57 +0100 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cd046fdb..f550d4c2 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,24 @@ Check the devices connected to your WIFI / LAN and alert you the 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)* +<> + +### Componets +The system consists of two parts: + +- **Back**: in charge of scanning the network searching connected devices, store the information in the DB, and reporting the changes detected by e-mail. + +- **Front**: a web frontal that allows to display, in a visual way, all the information collected by the back. + + # Installation Initially designed to run on a Raspberry PI, it can run on many Linux distributions. -# Dependencies -arp-scan +### Dependencies +- arp-scan +- Pi.hole (optional) +- dnsmasq (optional) # Contributions - Pi.hole