From 2d691e2bb545f4ceb5ebd1ad83a148bfc551ba91 Mon Sep 17 00:00:00 2001
From: marcsello <punkosdmarcell@rocketmail.com>
Date: Mon, 31 Jan 2022 22:23:14 +0100
Subject: [PATCH] Added readme

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3b60054
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# IoT IP Beacon
+
+Simple daemon that helps you find your lost IoT device on the open sea of IP addresses.
+
+## How it works?
+
+This simple daemon broadcast some basic system information every 10 seconds to the local subnet.
+
+These information are the following:
+ - Configured IP address of the sending interface
+ - Hostname
+ - Birbox software version
+ - Uptime
+
+The messages is formed as the following UTF-8 encoded string:
+```
+BIRBOX|{ipaddr}|{hostname}|{version}|{uptime}
+```
+
+The messages are broadcast to the 6969 UDP port.
+
+All you need is to listen to such packets on the network, so you can find your lost IoT device in no time.
+
+## Usage
+
+Just start the script as a system daemon. You may have to change the interface name.
\ No newline at end of file