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

Commit c2093aa

Browse files
committed
Merge pull request #14 from noffle/linkify
linkify all the things!
2 parents cbb2531 + e9f08c3 commit c2093aa

File tree

1 file changed

+20
-16
lines changed

1 file changed

+20
-16
lines changed

README.md

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ A valid (read: that follows this interface) IPFS core implementation, must expos
6464

6565
##### `JavaScript` - ipfs.object.new([callback])
6666

67-
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js)
67+
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][]
6868

6969
If no `callback` is passed, a promise is returned.
7070

@@ -84,13 +84,13 @@ If no `callback` is passed, a promise is returned.
8484

8585
- Object, with format `{ Data: <data>, Links: [] }`
8686
- Buffer, requiring that the encoding is specified on the options. If no encoding is specified, Buffer is treated as the Data field
87-
- [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js).
87+
- [DAGNode][]
8888

8989
`options` is a optional argument of type object, that can contain the following properties:
9090

9191
- `enc`, the encoding of the Buffer (json, yml, etc), if passed a Buffer.
9292

93-
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js)
93+
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][]
9494

9595
If no `callback` is passed, a promise is returned.
9696

@@ -106,7 +106,7 @@ If no `callback` is passed, a promise is returned.
106106

107107
##### `JavaScript` - ipfs.object.get(multihash, [options, callback])
108108

109-
`multihash` is a [multihash]() which can be passed as:
109+
`multihash` is a [multihash][] which can be passed as:
110110

111111
- Buffer, the raw Buffer of the multihash (or of and encoded version)
112112
- String, the toString version of the multihash (or of an encoded version)
@@ -115,7 +115,7 @@ If no `callback` is passed, a promise is returned.
115115

116116
- `enc`, the encoding of multihash (base58, base64, etc), if any.
117117

118-
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js)
118+
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][]
119119

120120
If no `callback` is passed, a promise is returned.
121121

@@ -126,7 +126,7 @@ If no `callback` is passed, a promise is returned.
126126
##### `Go` **WIP**
127127

128128
##### `JavaScript` - ipfs.object.data(multihash, [options, callback])
129-
`multihash` is a [multihash]() which can be passed as:
129+
`multihash` is a [multihash][] which can be passed as:
130130

131131
- Buffer, the raw Buffer of the multihash (or of and encoded version)
132132
- String, the toString version of the multihash (or of an encoded version)
@@ -147,7 +147,7 @@ If no `callback` is passed, a promise is returned.
147147

148148
##### `JavaScript` - ipfs.object.links(multihash, [options, callback])
149149

150-
`multihash` is a [multihash]() which can be passed as:
150+
`multihash` is a [multihash][] which can be passed as:
151151

152152
- Buffer, the raw Buffer of the multihash (or of and encoded version)
153153
- String, the toString version of the multihash (or of an encoded version)
@@ -172,7 +172,7 @@ If no `callback` is passed, a promise is returned.
172172

173173
##### `JavaScript` - ipfs.object.stat(multihash, [options, callback])
174174

175-
`multihash` is a [multihash]() which can be passed as:
175+
`multihash` is a [multihash][] which can be passed as:
176176

177177
- Buffer, the raw Buffer of the multihash (or of and encoded version)
178178
- String, the toString version of the multihash (or of an encoded version)
@@ -212,7 +212,7 @@ If no `callback` is passed, a promise is returned.
212212

213213
##### `JavaScript` - ipfs.object.patch.addLink(multihash, DAGLink, [options, callback])
214214

215-
`multihash` is a [multihash]() which can be passed as:
215+
`multihash` is a [multihash][] which can be passed as:
216216

217217
- Buffer, the raw Buffer of the multihash (or of and encoded version)
218218
- String, the toString version of the multihash (or of an encoded version)
@@ -223,7 +223,7 @@ If no `callback` is passed, a promise is returned.
223223

224224
- `enc`, the encoding of multihash (base58, base64, etc), if any.
225225

226-
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js) that resulted by the operation of adding a Link.
226+
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][] that resulted by the operation of adding a Link.
227227

228228
If no `callback` is passed, a promise is returned.
229229

@@ -239,7 +239,7 @@ If no `callback` is passed, a promise is returned.
239239

240240
##### `JavaScript` - ipfs.object.patch.rmLink(multihash, DAGLink, [options, callback])
241241

242-
`multihash` is a [multihash]() which can be passed as:
242+
`multihash` is a [multihash][] which can be passed as:
243243

244244
- Buffer, the raw Buffer of the multihash (or of and encoded version)
245245
- String, the toString version of the multihash (or of an encoded version)
@@ -250,7 +250,7 @@ If no `callback` is passed, a promise is returned.
250250

251251
- `enc`, the encoding of multihash (base58, base64, etc), if any.
252252

253-
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js) that resulted by the operation of adding a Link.
253+
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][] that resulted by the operation of adding a Link.
254254

255255
If no `callback` is passed, a promise is returned.
256256

@@ -266,7 +266,7 @@ If no `callback` is passed, a promise is returned.
266266

267267
##### `JavaScript` - ipfs.object.patch.appendData(multihash, data, [options, callback])
268268

269-
`multihash` is a [multihash]() which can be passed as:
269+
`multihash` is a [multihash][] which can be passed as:
270270

271271
- Buffer, the raw Buffer of the multihash (or of and encoded version)
272272
- String, the toString version of the multihash (or of an encoded version)
@@ -277,7 +277,7 @@ If no `callback` is passed, a promise is returned.
277277

278278
- `enc`, the encoding of multihash (base58, base64, etc), if any.
279279

280-
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js) that resulted by the operation of adding a Link.
280+
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][] that resulted by the operation of adding a Link.
281281

282282
If no `callback` is passed, a promise is returned.
283283

@@ -293,7 +293,7 @@ If no `callback` is passed, a promise is returned.
293293

294294
##### `JavaScript` - ipfs.object.patch.setData(multihash, data, [options, callback])
295295

296-
`multihash` is a [multihash]() which can be passed as:
296+
`multihash` is a [multihash][] which can be passed as:
297297

298298
- Buffer, the raw Buffer of the multihash (or of and encoded version)
299299
- String, the toString version of the multihash (or of an encoded version)
@@ -304,6 +304,10 @@ If no `callback` is passed, a promise is returned.
304304

305305
- `enc`, the encoding of multihash (base58, base64, etc), if any.
306306

307-
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode](https://github.com/vijayee/js-ipfs-merkle-dag/blob/master/src/dag-node.js) that resulted by the operation of adding a Link.
307+
`callback` must follow `function (err, node) {}` signature, where `err` is an error if the operation was not successful and `node` is a MerkleDAG node of the type [DAGNode][] that resulted by the operation of adding a Link.
308308

309309
If no `callback` is passed, a promise is returned.
310+
311+
312+
[DAGNode]: https://github.com/vijayee/js-ipfs-merkle-dag
313+
[multihash]: http://github.com/jbenet/multihash

0 commit comments

Comments
 (0)