Skip to content
This repository was archived by the owner on Aug 12, 2020. It is now read-only.

Commit f65abd6

Browse files
committed
more readme tweaks; squash me
1 parent 96a8aa2 commit f65abd6

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,12 +141,20 @@ exportEvent.on('data', (result) => {
141141

142142
## Exporter: API
143143
```js
144-
const Importer = require('ipfs-unixfs-engine').exporter
144+
const Exporter = require('ipfs-unixfs-engine').exporter
145145
```
146146

147-
The exporter is a readable stream in object mode that returns an object ```{
148-
content: stream, path: 'path' }``` by the multihash of the file from the dag
149-
service.
147+
The exporter is a readable stream in object mode that outputs objects of the
148+
form
149+
150+
```js
151+
{
152+
path: 'a name',
153+
content: (Buffer or Readable stream)
154+
}
155+
```
156+
157+
by the multihash of the file from the DAG Service.
150158

151159

152160
## Install

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "ipfs-unixfs-engine",
33
"version": "0.8.0",
44
"description": "JavaScript implementation of the unixfs Engine used by IPFS",
5-
"main": "lib/index.js",
5+
"main": "src/index.js",
66
"jsnext:main": "src/index.js",
77
"scripts": {
88
"lint": "aegir-lint",
@@ -70,4 +70,4 @@
7070
"greenkeeperio-bot <support@greenkeeper.io>",
7171
"nginnever <ginneversource@gmail.com>"
7272
]
73-
}
73+
}

0 commit comments

Comments
 (0)