after fixing the order of execution.

front/plugins/omada_sdn_imp/README.md

@@ -1,12 +1,24 @@
 ## Overview
 
-Plugin functionality overview and links to external resources if relevant. Include use cases if available. 
+The OMADA SDN plugin aims at synchronizing data between NetAlertX and a TPLINK OMADA SND controler by leveraging a tplink omada python library.
+#### features:
+1. extract list of OMADA Clients from OMADA and sync them up with NetAlertX
+2. extract list of OAMDA Devices (switches and access points) and sync them up with NetAlertX
 
 > [!TIP]
 > Some tip.
 
 ### Quick setup guide
 
+1. You SHOULD (ie: strongly recommend) setting up a dedicated account in your OMADA SDN console dedicated to NetAlertX OMADA_SDN plugin.
+- you should set  USER TYPE = Local USer
+- you should set  USER ROLE = Administrator  (if you use a read-only role you won't be able to sync names from NetAlerX to OMADA SDN)
+- you can set  Site Privileges = All Sites (or limit it to specific sites )
+
+2. populate the variables in NetAlertX as instructed in the config plugin page.
+
+
+
 To set up the plugin correctly, make sure...
 
 #### Required Settings
@@ -20,6 +32,37 @@ To set up the plugin correctly, make sure...
 
 ### Notes
 
-- Additional notes, limitations, Author info. 
+#### features not implemented yet:
+3. extract list of OAMDA router Devices (er605...) and sync them up with NetAlertX 
+(I need to setup my own er605 however due to its limitations I have no use for it, and due to limitations of opensense dhcp servers, I can't deploy it yet without breaking dhcp self registration into opnsense unbound - see below)
+
+#### know limitations:
+OMADA SDN limitation fixed by the plugin:
+0. OMADA SDN can't use DNS for names and keep using MAC ref: https://community.tp-link.com/en/business/forum/topic/503782
+- when you use an OMADA user Role =  Administrator, the plugin will attempt to fix OMADA's shortcoming and populat the NAME field from NetAlertX (from DNS/DHCP/...)
+![OMADA SDN account page](Oamadaomada_sdn_imp.png)
+- 
+
+can not fix some of tplinks OMADA SDN own limitations/bugs:
+1. OMADA SDN switches uplinks/downlinks is broken if the default router is not an OMADA native device 
+- (I try to circumvent that through a tree parsing heuristic but your mileage might vary...)
+- ref: https://community.tp-link.com/en/business/forum/topic/673628
+2.  OMADA SDN clients are sometimes mapped to the wrong switch/port... for instance:
+- client -> access_switch1/port1 -> core_switch2/port2 sometimes shows as client -> core_switch2/port2 
+- it is unclear if this issue is realted to (1)
+3. OMADA er605 routers do not self register DHCP names with a remote unbound DNS (nor embded DNS):
+- ref:  https://community.tp-link.com/en/business/forum/topic/542472
+- it looks like some release candidate firmware might provide this feature... I will test when opnsesne Kea self registration get fixed as well(4)and I can get it dhcp proxy to work.
+4. Opnsense dhcp doesn't support relay and self-registration at the same time...
+- opnsense legacy ISC dhcp server doesn't support dhcp  proxies:  ref: https://forum.opnsense.org/index.php?topic=34254.0 
+- opnsense new kea dhcp server doesn't support dns self registration (yet) ref: https://github.com/opnsense/core/pull/7362
+5. incompatible devices: 
+- OMADA EAP245 - to be fair to tp-link, this access point works inside OMADA SDN, so it might be an issue with our omada python library but we can't extract data from it.
+
+
+
+
+### Other infos
 
-Made with ❤ by [@FlyingToto](https://github.com/FlyingToto) 🙏
+- Author : Flying Toto
+- Date : 04-Jul-2024 - version 1.0