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

Commit 1b8557e

Browse files
maxlathdaviddias
authored andcommitted
readme: added missing API links (#560)
docs: even when linking to a 404 octocat, still better than the current empty links resolving to https://github.com/ipfs/js-ipfs-api/blob/master
1 parent 086fe6e commit 1b8557e

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

README.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -163,23 +163,23 @@ This means:
163163
- See https://github.com/ipfs/js-ipfs for details on
164164
pubsub in js-ipfs
165165

166-
##### [bitswap]()
166+
##### [bitswap](https://github.com/ipfs/interface-ipfs-core/tree/master/API/bitswap)
167167

168-
- [`ipfs.bitswap.wantlist()`]()
169-
- [`ipfs.bitswap.stat()`]()
170-
- [`ipfs.bitswap.unwant()`]()
168+
- [`ipfs.bitswap.wantlist()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/bitswap#wantlist)
169+
- [`ipfs.bitswap.stat()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/bitswap#stat)
170+
- [`ipfs.bitswap.unwant()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/bitswap#unwant)
171171

172172
##### [block](https://github.com/ipfs/interface-ipfs-core/tree/master/API/block)
173173

174174
- [`ipfs.block.get(cid, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/block#get)
175175
- [`ipfs.block.put(block, cid, [callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/block#put)
176176
- [`ipfs.block.stat(cid, [callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/block#stat)
177177

178-
##### [bootstrap]()
178+
##### [bootstrap](https://github.com/ipfs/interface-ipfs-core/tree/master/API/bootstrap)
179179

180-
- [`ipfs.bootstrap.list()`]()
181-
- [`ipfs.bootstrap.add()`]()
182-
- [`ipfs.bootstrap.rm()`]()
180+
- [`ipfs.bootstrap.list()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/bootstrap#list)
181+
- [`ipfs.bootstrap.add()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/bootstrap#add)
182+
- [`ipfs.bootstrap.rm()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/bootstrap#rm)
183183

184184
##### [config](https://github.com/ipfs/interface-ipfs-core/tree/master/API/config)
185185

@@ -193,11 +193,11 @@ This means:
193193
- [`ipfs.dag.get(cid [, path, options], callback)`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/dag#dagget)
194194
- [`ipfs.dag.tree(cid [, path, options], callback)`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/dag#dagtree)
195195

196-
##### [dht]()
196+
##### [dht](https://github.com/ipfs/interface-ipfs-core/tree/master/API/dht)
197197

198-
- [`ipfs.dht.findprovs()`]()
199-
- [`ipfs.dht.get()`]()
200-
- [`ipfs.dht.put()`]()
198+
- [`ipfs.dht.findprovs()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/dht#findprovs)
199+
- [`ipfs.dht.get()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/dht#get)
200+
- [`ipfs.dht.put()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/dht#put)
201201

202202
##### [files](https://github.com/ipfs/interface-ipfs-core/tree/master/API/files)
203203

@@ -210,31 +210,31 @@ This means:
210210
- alias to `ipfs.get`
211211
- [`ipfs.ls`]()
212212
- mfs (mutable file system) specific:
213-
- [`ipfs.files.cp`]()
214-
- [`ipfs.files.ls`]()
215-
- [`ipfs.files.mkdir`]()
216-
- [`ipfs.files.stat`]()
217-
- [`ipfs.files.rm`]()
218-
- [`ipfs.files.read`]()
219-
- [`ipfs.files.write`]()
220-
- [`ipfs.files.mv`]()
213+
- [`ipfs.files.cp`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/files#cp)
214+
- [`ipfs.files.ls`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/files#ls)
215+
- [`ipfs.files.mkdir`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/files#mkdir)
216+
- [`ipfs.files.stat`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/files#stat)
217+
- [`ipfs.files.rm`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/files#rm)
218+
- [`ipfs.files.read`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/files#read)
219+
- [`ipfs.files.write`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/files#write)
220+
- [`ipfs.files.mv`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/files#mv)
221221

222222
##### [generic operations](https://github.com/ipfs/interface-ipfs-core/tree/master/API/generic)
223223

224224
- [`ipfs.id([callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/generic#id)
225225
- [`ipfs.version([callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/generic#version)
226-
- [`ipfs.ping()`]()
227-
- [`ipfs.log()`]()
226+
- [`ipfs.ping()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/generic#ping)
227+
- [`ipfs.log()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/generic#log)
228228

229-
#### [key]()
229+
#### [key](https://github.com/ipfs/interface-ipfs-core/tree/master/API/key)
230230

231-
- [`ipfs.key.gen(name, [options, callback])`]()
232-
- [`ipfs.key.list([options, callback])`]()
231+
- [`ipfs.key.gen(name, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/key#gen)
232+
- [`ipfs.key.list([options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/key#list)
233233

234-
##### [name]()
234+
##### [name](https://github.com/ipfs/interface-ipfs-core/tree/master/API/name)
235235

236-
- [`ipfs.name.publish()`]()
237-
- [`ipfs.name.resolve()`]()
236+
- [`ipfs.name.publish()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/name#publish)
237+
- [`ipfs.name.resolve()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/name#resolve)
238238

239239
##### [object](https://github.com/ipfs/interface-ipfs-core/tree/master/API/object)
240240

@@ -249,11 +249,11 @@ This means:
249249
- [`ipfs.object.patch.appendData(multihash, data, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/object#objectpatchappenddata)
250250
- [`ipfs.object.patch.setData(multihash, data, [options, callback])`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/object#objectpatchsetdata)
251251

252-
##### [pin]()
252+
##### [pin](https://github.com/ipfs/interface-ipfs-core/tree/master/API/pin)
253253

254-
- [`ipfs.pin.add()`]()
255-
- [`ipfs.pin.rm()`]()
256-
- [`ipfs.pin.ls()`]()
254+
- [`ipfs.pin.add()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/pin#add)
255+
- [`ipfs.pin.rm()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/pin#rm)
256+
- [`ipfs.pin.ls()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/pin#ls)
257257

258258
##### [pubsub (not implemented, yet!)](https://github.com/ipfs/interface-ipfs-core/tree/master/API/pubsub)
259259

@@ -265,14 +265,14 @@ This means:
265265
- [`ipfs.pubsub.ls(topic, callback)`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/pubsub#pubsubls)
266266
- [`ipfs.pubsub.peers(topic, callback)`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/pubsub#pubsubpeers)
267267

268-
##### [refs]()
268+
##### [refs](https://github.com/ipfs/interface-ipfs-core/tree/master/API/refs)
269269

270-
- [`ipfs.refs.local()`]()
270+
- [`ipfs.refs.local()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/refs#local)
271271

272-
##### [repo]()
272+
##### [repo](https://github.com/ipfs/interface-ipfs-core/tree/master/API/repo)
273273

274-
- [`ipfs.repo.stat()`]()
275-
- [`ipfs.repo.gc()`]()
274+
- [`ipfs.repo.stat()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/repo#stat)
275+
- [`ipfs.repo.gc()`](https://github.com/ipfs/interface-ipfs-core/tree/master/API/repo#gc)
276276

277277
##### [swarm](https://github.com/ipfs/interface-ipfs-core/tree/master/API/swarm)
278278

0 commit comments

Comments
 (0)