From 9f173beddd0ee9ce7f0e0f0875f5967be3338aec Mon Sep 17 00:00:00 2001
From: joBr99 <29555657+joBr99@users.noreply.github.com>
Date: Fri, 7 Jan 2022 11:17:23 +0100
Subject: [PATCH] Update README.md

---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index aef961b4..706cb6e4 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,14 @@
-# nspanel-widget-ui
\ No newline at end of file
+# Note Current State
+This is at a really early stage, I stated on the implementation of the serial protocol.
+
+# NsPanel Custom Widget UI
+
+This is a replacement for the stock ui on nspanel, it can be controlled via custom serial command, like the stock one (but with different commands). This enables a user experiance, where it's possible to use nspanel with custom UI, but without messing around with Nextion Editor, because it's possible to configure widgets.
+
+# Custom Protocol
+```
+55 BB [payload length] [payload] [crc]
+```
+
+This protocol does not try to implement broken JSON Commands with a specified type (lol).
+Instead the commands are plain text commands with parameters.