bencode inspired tight self describing serialization format
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9f3bb17
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# bendncode
+
+a compact self-describing binary format, similar to CBOR or bencode.
+this should work with most serde attributes, unlike postcard or other non self-describing crates.
+
+an example:
+
+```json
+{
+ "hi": [1, "string"]
+}
+```
+
+bendncodes to
+
+```rs
+m 01 // map of length 1
+ s 02 // keyed with a string of length 2
+ hi // "hi"
+ l 02 // value of list of two elements
+ u 01 // an uinteger of one
+ s 06 // string(6) of "string"
+ string
+```