follow proposal on #6

ipfs-shipyard · Nov 23, 2015 · 409691c · 409691c
1 parent d81fd0b
commit 409691c
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 252 deletions.
diff --git a/README.md b/README.md
@@ -3,8 +3,16 @@ ipfs-blob-store
 
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) [[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs) ![Build Status](https://travis-ci.org/ipfs/ipfs-blob-store.svg?style=flat-square)](https://travis-ci.org/ipfs/ipfs-blob-store) ![](https://img.shields.io/badge/coverage-%3F-yellow.svg?style=flat-square) [![Dependency Status](https://david-dm.org/ipfs/ipfs-blob-store.svg?style=flat-square)](https://david-dm.org/ipfs/ipfs-blob-store) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
 
-![](https://github.com/maxogden/abstract-blob-store/raw/master/badge.png)
-
 > Implements the [abstract-blob-store](https://github.com/maxogden/abstract-blob-store) API, built on top of IPFS.
 
 ![](https://github.com/maxogden/abstract-blob-store/raw/master/badge.png)
+
+# Usage
+
+```JavaScript
+var ipfsBlobStore = require('ipfs-blob-store')
+
+var store = ipfsBlobStore()
+
+// then use abstract-blob-store interface
+```
diff --git a/lib/block.js b/lib/block.js
diff --git a/lib/dag.js b/lib/dag.js
diff --git a/index.js → src/index.js b/index.js → src/index.js
@@ -1,7 +1,5 @@
 var ipfs = require('ipfs-api')
-// var block = require('./lib/block')
-// var dag = require('./lib/dag')
-var mfs = require('./lib/mfs')
+var mfs = require('./mfs')
 
 module.exports = function (opts) {
   if (!opts) opts = {}
@@ -11,9 +9,5 @@ module.exports = function (opts) {
 
   var node = ipfs(opts.host, opts.port)
 
-  return {
-    // block: block(node),
-    // dag: dag(node),
-    mfs: mfs(node)
-  }
+  return mfs(node)
 }
diff --git a/lib/mfs.js → src/mfs.js b/lib/mfs.js → src/mfs.js
diff --git a/tests/block.js b/tests/block.js
diff --git a/tests/dag.js b/tests/dag.js
diff --git a/tests/mfs.js b/tests/mfs.js
@@ -1,10 +1,10 @@
 var test = require('tape')
 var abstractBlobTests = require('abstract-blob-store/tests')
-var ipfsBlobStore = require('../index.js')
+var ipfsBlobStore = require('../src')
 
 var common = {
   setup: function (t, cb) {
-    var store = ipfsBlobStore().mfs
+    var store = ipfsBlobStore()
 
     store.baseDir = '/tests/'