From 109535214ad31d42136b173fcedc75c83963a034 Mon Sep 17 00:00:00 2001
From: pauljako <paulifey18@proton.me>
Date: Thu, 27 Feb 2025 22:56:22 +0100
Subject: [PATCH] feat(README.md): added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6a0e35b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# bndd
+## The daemon for boundaries
+
+### Note: This repository is part of the [boundaries](https://github.com/pauljako/boundaries) rewrite as a client/server model. Once it is completed, the old boundaries will be deprecated.
+
+## Installing
+#### Note: Currently, bndd requires another boundaries installation to already be installed.
+
+You can compile the package with the following command (assuming [bpb](https://github.com/pauljako/bpb) and go are installed):
+```shell
+bpb .
+```
+
+After that you can install the built package inside the package/ directory