Update README.md

complete the list of modules

pialert/README.md

@@ -1,14 +1,50 @@
-# Pi.Alert all split into modules
+# Pi.Alert modules
 
-I am trying to split this big original file into modules and gives me some nice challanges to solve.
-Since the original code is all in one file, the original author has taken quite some shortcuts by defining lots of variables as global !!
-These need to be changed now.
-
-Here is the main structure
+The original pilaert.py code is now moved to this new folder and split into different modules.
 
 | Module | Description |
 |--------|-----------|
-|pialert.py | The MAIN program of Pi.Alert|
-|const.py | A place to define the constants for Pi.Alert like log path or config path.|
-|const.py| const.py holds the configuration variables and makes them availabe for all modules. It is also the <b>workaround</b> for the global variables until I can work them out|
-|api.py| |
+|```__main__.py```| The MAIN program of Pi.Alert|
+|```__init__.py```| an empty init file|
+|```README.md```| this readme file|
+|**publishers**| a folder containing all modules used to publish the results|
+|**scanners**| a folder containing all modules used to scan for devices |
+|```api.py```| updating the API endpoints with the relevant data. (Should move to publishers)|
+|```const.py```| A place to define the constants for Pi.Alert like log path or config path.|
+|```conf.py```| conf.py holds the configuration variables and makes them available for all modules. It is also the <b>workaround</b> for global variables that need to be resolved at some point|
+|```database.py```| This module connects to the DB, makes sure the DB is up to date and defines some standard queries and interfaces. |
+|```device.py```| The device module looks after the devices and saves the scan results into the devices |
+|```helper.py```| Helper as the name suggest contains multiple little functions and methods used in many of the other modules and helps keep things clean |
+|```initialise.py```| Initiatlise sets up the environment and makes everything ready to go |
+|```logger.py```| Logger is there the keep all the logs organised and looking identical. |
+|```mac_vendor.py```| This module runs and manages the ``` update_vendors.sh ``` script from within Pi.Alert |
+|```networscan.py```| Networkscan orchestrates the actual scanning of the network, calling the individual scanners and managing the results |
+|```plugin.py```| This is where the plugins get integrated into the backend of Pi.Alert |
+|```reporting.py```| Reporting generates the email, html and json reports to be sent by the publishers |
+|```scheduler.py```| All things scheduling |
+
+## publishers
+publishers generally have a check_config method as well as a send method.
+
+| Module | Description |
+|--------|-----------|
+|```__init__.py```| an empty init file|
+|```apprise.py```| use apprise to integrate to "everywhere" https://github.com/caronc/apprise |
+|```email.py```| Configure and send the reports and notifications via email |
+|```mqtt.py```| integrate with a MQTT broker and even make the devices automatically discoverable in Home-Assistant |
+|```ntfy.py```| integrate with ntfy |
+|```pushsafer.py```| integrate with pushsafer |
+|```webhook.py```| integrate via webhook |
+
+## scanners
+different methods to scan the network for devices or to find more details about the discovered devices
+
+| Module | Description |
+|--------|-----------|
+|```__init__.py```| an empty init file (oops missing in the repo)|
+|```arpscan.py```| run an arp-scan to discover devices |
+|```internet.py```| discover the internet interface and check the external IP also manage Dynamic DNS |
+|```nmapscan.py```| use Nmap to discover more about devices |
+|```pholusscan.py```| use a 3rd party script Pholus to detect more details about the devices on the network |
+|```pihole.py```| Use the PiHole network table in its db and also read the DHCP leases file to discover new devices  |
+