[Release candidate] v10 prerelease

.gitignore

@@ -1,3 +1,61 @@
-node_modules
-sandbox.js
-sandbox
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next

.travis.yml

@@ -1,5 +1,6 @@
 language: node_js
 node_js:
+  - "node"
+  - "lts/*"
+  - "10"
   - "8"
-  - "6"
-  - "4"

README.md

@@ -1,5 +1,8 @@
 # Hyperdrive
 
+#### *Note*: This is a prerelease version of Hyperdrive that's backed by [Hypertrie](https://github.com/mafintosh/hypertrie)
+#### This version is not yet API-complete. 
+
 Hyperdrive is a secure, real time distributed file system
 
 ``` js
@@ -80,7 +83,6 @@ Options include:
   sparseMetadata: true // only download data on metadata feed when requested
   metadataStorageCacheSize: 65536 // how many entries to use in the metadata hypercore's LRU cache
   contentStorageCacheSize: 65536 // how many entries to use in the content hypercore's LRU cache
-  treeCacheSize: 65536 // how many entries to use in the append-tree's LRU cache
 }
 ```
 
@@ -145,10 +147,6 @@ You can use this with `.checkout(version)` to download a specific version of the
 archive.checkout(version).download()
 ```
 
-#### `var stream = archive.history([options])`
-
-Get a stream of all changes and their versions from this archive.
-
 #### `var stream = archive.createReadStream(name, [options])`
 
 Read a file out as a stream. Similar to fs.createReadStream.
@@ -180,20 +178,6 @@ or a string can be passed as options to simply set the encoding - similar to fs.
 
 If `cached` is set to `true`, this function returns results only if they have already been downloaded.
 
-#### `var stream = archive.createDiffStream(version, [options])`
-
-Diff this archive this another version. `version` can both be a version number of a checkout instance of the archive. The `data` objects looks like this
-
-``` js
-{
-  type: 'put' | 'del',
-  name: '/some/path/name.txt',
-  value: {
-    // the stat object
-  }
-}
-```
-
 #### `var stream = archive.createWriteStream(name, [options])`
 
 Write a file as a stream. Similar to fs.createWriteStream.
@@ -263,13 +247,10 @@ stat.isFile()
 Options include:
 ```js
 {
-  cached: true|false // default: false,
   wait: true|false // default: true
 }
 ```
 
-If `cached` is set to `true`, this function returns results only if they have already been downloaded.
-
 If `wait` is set to `true`, this function will wait for data to be downloaded. If false, will return an error.
 
 #### `archive.lstat(name, [options], callback)`
@@ -279,13 +260,10 @@ Stat an entry but do not follow symlinks. Similar to fs.lstat.
 Options include:
 ```js
 {
-  cached: true|false // default: false,
   wait: true|false // default: true
 }
 ```
 
-If `cached` is set to `true`, this function returns results only if they have already been downloaded.
-
 If `wait` is set to `true`, this function will wait for data to be downloaded. If false, will return an error.
 
 #### `archive.access(name, [options], callback)`
@@ -295,25 +273,12 @@ Similar to fs.access.
 Options include:
 ```js
 {
-  cached: true|false // default: false,
   wait: true|false // default: true
 }
 ```
 
-If `cached` is set to `true`, this function returns results only if they have already been downloaded.
-
 If `wait` is set to `true`, this function will wait for data to be downloaded. If false, will return an error.
 
-#### `archive.open(name, flags, [mode], callback)`
-
-Open a file and get a file descriptor back. Similar to fs.open.
-
-Note that currently only read mode is supported in this API.
-
-#### `archive.read(fd, buf, offset, len, position, callback)`
-
-Read from a file descriptor into a buffer. Similar to fs.read.
-
 #### `archive.close(fd, [callback])`
 
 Close a file. Similar to fs.close.