diff --git a/README.md b/README.md index 41e4a928..f2dac312 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,19 @@ # Pi.Alert -WIFI / LAN intruder detector. Check the devices connected and alert you with unknown devices. -It also warns of the disconnection of "always connected" devices +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. + +# Installation +Initially designed to run on a Raspberry PI, it can run on many Linux distributions. + +# Dependencies +arp-scan + +# Contributors +Pi.hole +Admin.LTE + +# License +GPL 3.0 +