re-add stashed documentation updates for v2, wups

[squeep-mystery-box] / README.md

diff --git a/README.md b/README.md
index b7ad9d4fd0ac5dbff6aa89260295c221fc23113d..a8db0a66a986254f2c210c0662d76a96d4aaac19 100644 (file)
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ In our case, this results in a Base64URL encoded string containing a bespoke pac
 const { MysteryBox } = require('@squeep/mystery-box');
 const assert = require('assert');
 
-const mb = new MysteryBox(console, {
+const mb = new MysteryBox({
   encryptionSecret: 'very secret',
 });
 
@@ -33,3 +33,7 @@ const mb = new MysteryBox(console, {
 This relies on AEAD ciphers, such as `aes-256-gcm` and `chacha20-poly1305`, to encrypt the payload and authenticate the additional metadata (version identifier, flags indicating payload details, the iv of the cipher, and the salt used to create the key) needed to decrypt the payload.
 
 For each box, a new key is generated using the stored secret and a securely-random salt by way of a mechanism such as an XOF such as `shake256`, a hash such as `blake2b512`, or a more time-consuming multi-round hash such as `scrypt`.  This key is used to encrypt and authenticate the data and metadata, which is then encoded as a base64url string.
+
+## Statistics
+
+A `statistics` event is emitted for every pack or unpack, containing timing and other information.