summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2026-07-13 21:11:16 +0100
committerMichael Williamson <mike@zwobble.org>2026-07-13 21:11:16 +0100
commit5f8009a7ddf811aa907959d47dd3c9c5afd5d3db (patch)
tree7f52df6ef153163cd23c03e9f9e7335dd08ad0e0
parentae82aefd4ac03a5d6b87ac9aa16719a0935a91e0 (diff)
Add transient-0 docs
-rw-r--r--docs/transient-0.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/transient-0.md b/docs/transient-0.md
new file mode 100644
index 0000000..42d956f
--- /dev/null
+++ b/docs/transient-0.md
@@ -0,0 +1,18 @@
+# transient-0
+
+transient-0 is a binary encoding of hobgoblin data is for transient data where
+forwards and backwards compatibility is not required, such as IPC between
+different instances of the same program.
+
+The encoder and decoder must use the same version of hobgoblin and the same data
+definitions for decoding to succeed.
+
+transient-0 does not support:
+* Compatibility between different versions of hobgoblin. The exact encoding is
+ an implementation detail that may change between any two versions of
+ hobgoblin.
+* Compatibility between different data definitions. For instance, if a field is
+ added to a struct, there is no guarantee that data encoded before the field
+ was added can be decoded using the new data definition.
+
+