From ed797a8c00c0725df7170bd6f498da785f765b84 Mon Sep 17 00:00:00 2001
From: "Matthias P. Braendli" <matthias.braendli@mpb.li>
Date: Tue, 2 Jan 2024 18:06:28 +0100
Subject: Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eddcfed
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# CATS Radio Node
+
+This project contains a web user interface for controlling a
+[https://cats.radio](CATS Radio) device, consisting of a Raspberry Pi with a
+[https://gitlab.scd31.com/cats/pi-hardware](RF4463 hat).
+
+## Goals
+
+1. Show incoming packets, and store them in the sqlite database `cats-radio-node.db`
+1. Allow the user to send custom packets
+1. Configure igate and other settings, stored in `node-config.toml`
+
+## Current state of the project
+
+Configuration read/write through UI is done.
+
+Pending: RF4463 integration, message decoding and presentation, igate integration, UI to send messages
-- 
cgit v1.2.3