BREAKING: Use abstract-chunk-store for storage

Part of an effort to share more code with `torrent-stream` by
@mafintosh:

https://github.com/mafintosh/torrent-stream/pull/133
https://github.com/mafintosh/torrent-stream/pull/132

Storage is now based on:

https://www.npmjs.com/package/fs-chunk-store (in node)
https://www.npmjs.com/package/memory-chunk-store (in the browser)

and:

https://www.npmjs.com/package/immediate-chunk-store
https://www.npmjs.com/package/torrent-piece

This is a BREAKING change, since users who pass in custom storage
engine with `opts.storage` will need to update their storage backend to
be `abstract-chunk-store` compliant:

https://www.npmjs.com/package/abstract-chunk-store

There are also likely other miscellaneous BREAKING API changes, since
this was a huge refactor of the codebase.

1 files changed, 5 insertions, 5 deletions

diff --git a/README.md b/README.md
index 9e7d348..94ab6af 100644
--- a/README.md
+++ b/README.md
@@ -230,9 +230,8 @@ If `opts` is specified, then the default options (shown below) will be overridde
   nodeId: String|Buffer, // DHT protocol node ID (default=randomly generated)
   peerId: String|Buffer, // Wire protocol peer ID (default=randomly generated)
   rtcConfig: Object,     // RTCPeerConnection configuration object (default=STUN only)
-  storage: Function,     // custom storage engine, or `false` to use in-memory engine
   tracker: Boolean,      // Whether or not to enable trackers (default=true)
-  wrtc: {}               // custom webrtc implementation (in node, specify the [wrtc](https://www.npmjs.com/package/wrtc) package)
+  wrtc: {}               // Custom webrtc implementation (in node, specify the [wrtc](https://www.npmjs.com/package/wrtc) package)
 }
 ```
 
@@ -253,9 +252,10 @@ If `opts` is specified, then the default options (shown below) will be overridde
 
 ```js
 {
-  announce: [],    // List of additional trackers to use (added to list in .torrent or magnet uri)
-  path: String,    // Folder where files will be downloaded (default=`/tmp/webtorrent/`)
-  verify: Boolean  // Verify previously stored data before starting (default=false)
+  announce: [],      // List of additional trackers to use (added to list in .torrent or magnet uri)
+  path: String,      // Folder where files will be downloaded (default=`/tmp/webtorrent/`)
+  storage: Function, // Custom storage engine (must follow `abstract-chunk-store` API)
+  verify: Boolean    // Verify previously stored data before starting (default=false)
 }
 ```