Adds API for ipfs.files.get.

Author: hackergrrl

API/files/README.md

@@ -1,4 +1,4 @@
-files API
+Files API
 =========
 
 #### `add`
@@ -92,8 +92,43 @@ ipfs.files.createAddStream(function (err, stream) {
 
 
 
+### `get`
 
-#### `cat` 
+> Get [UnixFS][] files from IPFS.
+
+##### `Go` **WIP**
+
+##### `JavaScript` - ipfs.files.get(hash, [callback])
+
+Where `hash` is an IPFS multiaddress or multihash.
+
+`callback` must follow `function (err, stream) {}` signature, where `err` is an
+error if the operation was not successful. `stream` will be a Readable stream,
+outputting objects of the form
+
+```js
+{
+  path: '/tmp/myfile.txt',
+  content: Readable stream
+}
+```
+
+If no `callback` is passed, a promise is returned with the Readable stream.
+
+Example:
+
+```js
+ipfs.files.get('QmQ2r6iMNpky5f1m4cnm3Yqw8VSvjuKpTcK1X7dBR1LkJF', function (err, stream) {
+  stream.on('data', (file) => {
+    console.log(file.path)
+    file.content.pipe(process.stdout)
+  })
+})
+```
+
+
+
+#### `cat`
 
 > Streams the file at the given IPFS multihash..
 
@@ -103,7 +138,7 @@ ipfs.files.createAddStream(function (err, stream) {
 
 `multihash` is a [multihash][] which can be passed as
 
-- Buffer, the raw Buffer of the multihash 
+- Buffer, the raw Buffer of the multihash
 - String, the base58 encoded version of the multihash
 
 `callback` must follow `function (err, stream) {}` signature, where `err` is an error if the operation was not successful and `stream` is a readable stream of the file.

README.md

@@ -60,14 +60,14 @@ interface-ipfs-core API.
 
 ## Install
 
-In JavaScript land:
-```js
+In JavaScript using [npm](http://npmjs.org/):
+```
 npm install interface-ipfs-core
 ```
 
 In Go land:
 
-```go
+```
 # Not available
 ```
 
@@ -114,3 +114,5 @@ This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/c
 ## License
 
 MIT
+
+[UnixFS]: https://github.com/ipfs/specs/tree/master/unixfs