From e5bc4ad41ba911fa5d47aa42a48d973d2f749244 Mon Sep 17 00:00:00 2001
From: Roland Beck <7224371+Data-Monkey@users.noreply.github.com>
Date: Wed, 10 May 2023 20:46:58 +1000
Subject: [PATCH] Update README.md

added statement about file format and example
---
 front/plugins/dhcp_leases/README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/front/plugins/dhcp_leases/README.md b/front/plugins/dhcp_leases/README.md
index e96bc5d8..bba55962 100755
--- a/front/plugins/dhcp_leases/README.md
+++ b/front/plugins/dhcp_leases/README.md
@@ -29,4 +29,25 @@ DHCPLSS_paths_to_check = ['/mnt/dhcp1.leases','/mnt/dhcp2.leases']
 
 ### Notes
 
-- No specific configuration needed.
\ No newline at end of file
+- No specific configuration needed.
+
+- This plugin expects the dhcp.leases file(s) to be in the format of **dhcpd.leases** that is different to the format that PiHole uses. 
+[dhcpd.leases(5) - Linux man page]( https://linux.die.net/man/5/dhcpd.leases#:~:text=This%20database%20is%20a%20free,file%20is%20the%20current%20one.) 
+
+Example File Format:  _(not all lines are required)_
+
+```
+lease 192.168.79.15 {
+  starts 0 2016/08/21 13:25:45;
+  ends 0 2016/08/21 19:25:45;
+  cltt 0 2016/08/21 13:25:45;
+  binding state active;
+  next binding state free;
+  rewind binding state free;
+  hardware ethernet 8c:1a:bf:11:00:ea;
+  uid "\001\214\032\277\021\000\352";
+  option agent.circuit-id 0:17;
+  option agent.remote-id c0:a8:9:5;
+  client-hostname "android-8182e21c852776e7";
+}  
+```