initial commit

[squeep-mystery-box] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..e070bb2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# Mystery Box
+
+Our very own way of converting a buffer or serializable object to and from an opaque and web-safe representation, which we can let anyone see without disclosing the contents, nor allowing it to be modified without detection.
+
+In our case, this results in a Base64URL encoded string containing a bespoke packing of encrypted and verified data.
+
+## API
+
+- pack(contents, version, flags)
+- unpack(box)