From 3e894b92c424b5bcd33b3a7772468ee18e52a85e Mon Sep 17 00:00:00 2001
From: _ <_@_>
Date: Sun, 13 Apr 2025 23:51:50 -0500
Subject: [PATCH] a little readme-driven development

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a985adc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+Length-prefixed framing for byte streams. Similar to Tokio's codec module or Ogg.
+
+Structures:
+
+- Framer - Takes datagrams and returns a byte stream.
+- Deframer - Takes a byte stream and returns datagrams.
+- Multiplexer - Takes multiple byte streams and returns one byte stream.
+- Demultiplexer - Takes one byte stream and returns multiple byte streams.
+- MultiFramer - A convenience wrapper around Framers and a Multiplexer, which takes datagrams of multiple streams and returns one byte stream.
+- DeMultiFramer - A convenience wrapper around Deframers and a Demultiplexer, which takes one byte stream and returns datagrams of multiple streams.