bump package version to 1.0.1
[squeep-mystery-box] / README.md
1 # Mystery Box
2
3 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.
4
5 In our case, this results in a Base64URL encoded string containing a bespoke packing of encrypted and verified data.
6
7 ## API
8
9 - pack(contents, version, flags)
10 - unpack(box)