Merge pull request #886 from 3box/release/v1.21.0

Release/v1.21.0

Author: zachferland

README.md

@@ -614,6 +614,7 @@ Creates an instance of 3Box
 | opts.addressServer | <code>String</code> | URL of the Address Server |
 | opts.ghostPinbot | <code>String</code> | MultiAddress of a Ghost Pinbot node |
 | opts.supportCheck | <code>String</code> | Gives browser alert if 3boxjs/ipfs not supported in browser env, defaults to true. You can also set to false to implement your own alert and call Box.support to check if supported. |
+| opts.iframeCache | <code>Boolean</code> | Enable iframe cache for ipfs/orbit, defaults to true |
 
 <a name="Box.supported"></a>
 

RELEASE-NOTES.md

@@ -1,5 +1,10 @@
 # Release Notes
 
+## v1.21.0 - 2020-08-06
+
+* feat: shared ipfs and orbitdb iframe cache for faster auth/openbox and syncs
+* fix: ledger support
+
 ## v1.20.3 - 2020-07-13
 This release upgrades ipfs to 0.46.0, adds a fix that may allow some older accounts to be loaded/synced again, and downgrades libp2p-pubsub as temporary fix for connect/gossipsub errors.
 

example/README.md

@@ -0,0 +1,10 @@
+## <a name="example"></a> Example Application
+
+You can quickly run and interact with the example code in this directory. You run the example with the following commands:
+
+```bash
+$ npm ci
+$ npm run example:start
+```
+
+This runs a simple server at `http://localhost:30000/` that serves the static `example/index.html` file. This allows it easily interact with Metamask. You can edit the `example/index.html` file to try different code.