aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWill Dillon <william@housedillon.com>2025-11-08 13:38:48 +0000
committerWill Dillon <william@housedillon.com>2025-11-08 13:38:48 +0000
commit5faf27b74dedcd2258c0255dd212c69f3dc1df6d (patch)
treecbcf207642bdf31d106f2ee2b34cfdb6c69b7857
parentPrepare for publication (diff)
downloadmeshcore-rs-5faf27b74dedcd2258c0255dd212c69f3dc1df6d.tar.gz
meshcore-rs-5faf27b74dedcd2258c0255dd212c69f3dc1df6d.zip
Prepare for publication
-rw-r--r--readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..2f2523d
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,15 @@
+#MeshCore
+
+This crate provides the tools to:
+
+* Parse MeshCore packet
+* Decrypt MeshCore packet contents (when keys are provided)
+
+It will be enhanced over time to:
+
+* Serialize MeshCore packets
+* Send Dissected packets into Wireshark
+
+## WARNING!
+
+This is very early work, and the API is likely in flux! \ No newline at end of file