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

Commit bfba767

Browse files
authored
docs: Update interface-ipfs-core links (#2910)
1 parent 743a7fc commit bfba767

File tree

29 files changed

+276
-276
lines changed

29 files changed

+276
-276
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
</p>
2020

2121
<p align="center">
22-
<a href="https://github.com/ipfs/interface-ipfs-core"><img src="https://img.shields.io/badge/interface--ipfs--core-API%20Docs-blue.svg"></a>
22+
<a href="https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core"><img src="https://img.shields.io/badge/interface--ipfs--core-API%20Docs-blue.svg"></a>
2323
<a href="https://travis-ci.com/ipfs/js-ipfs?branch=master"><img src="https://badgen.net/travis/ipfs/js-ipfs?branch=master" /></a>
2424
<a href="https://codecov.io/gh/ipfs/js-ipfs"><img src="https://badgen.net/codecov/c/github/ipfs/js-ipfs" /></a>
2525
<br>
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Using duplex streams to add files to IPFS in the browser
22

3-
If you have a number of files that you'd like to add to IPFS and end up with a hash representing the directory containing your files, you can invoke [`ipfs.add`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#add) with an array of objects.
3+
If you have a number of files that you'd like to add to IPFS and end up with a hash representing the directory containing your files, you can invoke [`ipfs.add`](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/SPEC/FILES.md#add) with an array of objects.
44

5-
But what if you don't know how many there will be in advance? You can add multiple files to a directory in IPFS over time by using [`ipfs.addReadableStream`](https://github.com/ipfs/interface-ipfs-core/blob/master/SPEC/FILES.md#addreadablestream).
5+
But what if you don't know how many there will be in advance? You can add multiple files to a directory in IPFS over time by using [`ipfs.addReadableStream`](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/SPEC/FILES.md#addreadablestream).
66

77
See `index.js` for a working example and open `index.html` in your browser to see it run.

examples/browser-script-tag/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
// You can write more code here to use it. Use methods like
1717
// node.add, node.get. See the API docs here:
18-
// https://github.com/ipfs/interface-ipfs-core
18+
// https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core
1919
})
2020
</script>
2121
</head>

examples/ipfs-101/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Version: 0.31.2
4646

4747
Now let's make it more interesting and add a file to IPFS using `node.add`. A file consists of a path and content.
4848

49-
You can learn about the IPFS File API at [interface-ipfs-core](https://github.com/ipfs/interface-js-ipfs-core/blob/master/SPEC/FILES.md).
49+
You can learn about the IPFS File API at [interface-ipfs-core](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/SPEC/FILES.md).
5050

5151
```js
5252
const IPFS = require('ipfs')

examples/traverse-ipld-graphs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Resolve through IPLD graphs with the dag API
33

44
IPLD stands for [`InterPlanetary Linked-Data`](https://ipld.io/), it is the data model of the content-addressable web. It gives IPFS the ability to resolve through any kind of content-addressed graph, as long as the [adapter for the format is available](https://github.com/ipld/interface-ipld-format#modules-that-implement-the-interface).
55

6-
This tutorial goes through several operations over IPLD graphs using the [DAG API](https://github.com/ipfs/interface-ipfs-core/tree/master/API/dag).
6+
This tutorial goes through several operations over IPLD graphs using the [DAG API](https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core/API/dag).
77

88
## [create nodes to build a graph](./put.js)
99

packages/interface-ipfs-core/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -889,7 +889,7 @@ in the diff because using `new` stops us from destructuring in js.
889889

890890
### BREAKING CHANGES
891891

892-
* Consumers of this test suite now have fine grained control over what tests are run. Tests can now be skipped and "onlyed" (run only specific tests). This can be done on a test, command and sub-system level. See the updated usage guide for instructions: https://github.com/ipfs/interface-ipfs-core/blob/master/README.md#usage.
892+
* Consumers of this test suite now have fine grained control over what tests are run. Tests can now be skipped and "onlyed" (run only specific tests). This can be done on a test, command and sub-system level. See the updated usage guide for instructions: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/README.md#usage.
893893

894894
This means that tests skips depending on implementation (e.g. go/js), environment (e.g. node/browser) or platform (e.g. macOS/linux/windows) that were previously present in this suite have been removed. Consumers of this library should add their own skips based on the implementation that's being tested and the environment/platform that the tests are running on.
895895

packages/interface-ipfs-core/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Include this badge in your readme if you make a new module that implements inter
4646
![](img/badge.svg)
4747

4848
```md
49-
[![IPFS Core API Compatible](https://cdn.rawgit.com/ipfs/interface-ipfs-core/master/img/badge.svg)](https://github.com/ipfs/interface-ipfs-core)
49+
[![IPFS Core API Compatible](https://cdn.rawgit.com/ipfs/interface-ipfs-core/master/img/badge.svg)](https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core)
5050
```
5151

5252
## Install
@@ -175,7 +175,7 @@ In order to be considered "valid", an IPFS core implementation must expose the A
175175

176176
## Contribute
177177

178-
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/interface-ipfs-core/issues)!
178+
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-ipfs/issues)!
179179

180180
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
181181

packages/interface-ipfs-core/SPEC/BITSWAP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,5 +79,5 @@ console.log(stats)
7979
A great source of [examples][] can be found in the tests for this API.
8080

8181
[1]: https://github.com/MikeMcl/bignumber.js/
82-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/bitswap
82+
[examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/bitswap
8383
[cid]: https://www.npmjs.com/package/cids

packages/interface-ipfs-core/SPEC/BLOCK.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,5 +187,5 @@ A great source of [examples][] can be found in the tests for this API.
187187

188188
[block]: https://github.com/ipfs/js-ipfs-block
189189
[multihash]: https://github.com/multiformats/multihash
190-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/block
190+
[examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/block
191191
[cid]: https://www.npmjs.com/package/cids

packages/interface-ipfs-core/SPEC/BOOTSTRAP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,4 +113,4 @@ console.log(res.Peers)
113113

114114
A great source of [examples][] can be found in the tests for this API.
115115

116-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/bootstrap
116+
[examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/bootstrap

packages/interface-ipfs-core/SPEC/CONFIG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,4 +134,4 @@ Note that you will need to restart your node for config changes to take effect.
134134

135135
A great source of [examples][] can be found in the tests for this API.
136136

137-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/config
137+
[examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/config

packages/interface-ipfs-core/SPEC/DAG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,4 +166,4 @@ console.log(result)
166166
A great source of [examples][] can be found in the tests for this API.
167167

168168

169-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/dag
169+
[examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/dag

packages/interface-ipfs-core/SPEC/DHT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,4 +256,4 @@ https://github.com/libp2p/go-libp2p-core/blob/6e566d10f4a5447317a66d64c7459954b9
256256

257257
A great source of [examples][] can be found in the tests for this API.
258258

259-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/dht
259+
[examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/dht

packages/interface-ipfs-core/SPEC/FILES.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ for await (const file of ipfs.add(urlSource('https://ipfs.io/images/ipfs-logo.sv
208208
*/
209209
```
210210

211-
A great source of [examples](https://github.com/ipfs/interface-js-ipfs-core/blob/master/src/add.js) can be found in the tests for this API.
211+
A great source of [examples](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/add.js) can be found in the tests for this API.
212212

213213
#### `cat`
214214

@@ -247,7 +247,7 @@ for await (const chunk of ipfs.cat(ipfsPath)) {
247247
console.log(Buffer.concat(chunks).toString())
248248
```
249249

250-
A great source of [examples](https://github.com/ipfs/interface-js-ipfs-core/blob/master/src/cat.js) can be found in the tests for this API.
250+
A great source of [examples](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/cat.js) can be found in the tests for this API.
251251

252252
#### `get`
253253

@@ -303,7 +303,7 @@ for await (const file of ipfs.get(cid)) {
303303
}
304304
```
305305

306-
A great source of [examples](https://github.com/ipfs/interface-js-ipfs-core/blob/master/src/get.js) can be found in the tests for this API.
306+
A great source of [examples](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/get.js) can be found in the tests for this API.
307307

308308
#### `ls`
309309

@@ -353,7 +353,7 @@ for await (const file of ipfs.ls(cid)) {
353353
}
354354
```
355355

356-
A great source of [examples](https://github.com/ipfs/interface-js-ipfs-core/blob/master/src/ls.js) can be found in the tests for this API.
356+
A great source of [examples](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/ls.js) can be found in the tests for this API.
357357

358358
---
359359

packages/interface-ipfs-core/SPEC/KEY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,4 +204,4 @@ console.log(key)
204204

205205
A great source of [examples][] can be found in the tests for this API.
206206

207-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/key
207+
[examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/key

packages/interface-ipfs-core/SPEC/MISCELLANEOUS.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ const identity = await ipfs.id()
3434
console.log(identity)
3535
```
3636

37-
A great source of [examples](https://github.com/ipfs/interface-ipfs-core/blob/master/src/miscellaneous/id.js) can be found in the tests for this API.
37+
A great source of [examples](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/miscellaneous/id.js) can be found in the tests for this API.
3838

3939
#### `version`
4040

@@ -55,7 +55,7 @@ const version = await ipfs.version()
5555
console.log(version)
5656
```
5757

58-
A great source of [examples](https://github.com/ipfs/interface-ipfs-core/blob/master/src/miscellaneous/version.js) can be found in the tests for this API.
58+
A great source of [examples](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/miscellaneous/version.js) can be found in the tests for this API.
5959

6060
#### `dns`
6161

@@ -81,7 +81,7 @@ const path = await ipfs.dns('ipfs.io')
8181
console.log(path)
8282
```
8383

84-
A great source of [examples](https://github.com/ipfs/interface-ipfs-core/blob/master/src/miscellaneous/dns.js) can be found in the tests for this API.
84+
A great source of [examples](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/miscellaneous/dns.js) can be found in the tests for this API.
8585

8686
#### `stop`
8787

@@ -101,7 +101,7 @@ A great source of [examples](https://github.com/ipfs/interface-ipfs-core/blob/ma
101101
await ipfs.stop()
102102
```
103103

104-
A great source of [examples](https://github.com/ipfs/interface-ipfs-core/blob/master/src/miscellaneous/stop.js) can be found in the tests for this API.
104+
A great source of [examples](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/miscellaneous/stop.js) can be found in the tests for this API.
105105

106106
#### `ping`
107107

@@ -145,7 +145,7 @@ for await (const res of ipfs.ping('Qmhash')) {
145145
}
146146
```
147147

148-
A great source of [examples](https://github.com/ipfs/interface-ipfs-core/tree/master/src/ping) can be found in the tests for this API.
148+
A great source of [examples](https://github.com/ipfs/js-ipfs/tree/master/packages/interface-ipfs-core/src/ping) can be found in the tests for this API.
149149

150150
#### `resolve`
151151

@@ -204,8 +204,8 @@ const res = await ipfs.resolve(name)
204204
console.log(res) // /ipfs/QmYRMjyvAiHKN9UTi8Bzt1HUspmSRD8T8DwxfSMzLgBon1
205205
```
206206

207-
A great source of [examples](https://github.com/ipfs/interface-ipfs-core/blob/master/src/miscellaneous/resolve.js) can be found in the tests for this API.
207+
A great source of [examples](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/miscellaneous/resolve.js) can be found in the tests for this API.
208208

209-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/miscellaneous
209+
[examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/miscellaneous
210210
[rs]: https://www.npmjs.com/package/readable-stream
211211
[ps]: https://www.npmjs.com/package/pull-stream

packages/interface-ipfs-core/SPEC/NAME.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,5 +193,5 @@ for await (const name of ipfs.name.resolve(addr)) {
193193

194194
A great source of [examples][] can be found in the tests for this API.
195195

196-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/name
197-
[examples-pubsub]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/name-pubsub
196+
[examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/name
197+
[examples-pubsub]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/name-pubsub

packages/interface-ipfs-core/SPEC/OBJECT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -406,4 +406,4 @@ A great source of [examples][] can be found in the tests for this API.
406406
[CID]: https://github.com/multiformats/js-cid
407407
[DAGNode]: https://github.com/ipld/js-ipld-dag-pb
408408
[multihash]: http://github.com/multiformats/multihash
409-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/object
409+
[examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/object

packages/interface-ipfs-core/SPEC/PIN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,5 +101,5 @@ console.log(pinset)
101101

102102
A great source of [examples][] can be found in the tests for this API.
103103

104-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/pin
104+
[examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/pin
105105
[cid]: https://www.npmjs.com/package/cids

packages/interface-ipfs-core/SPEC/PUBSUB.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,4 +158,4 @@ console.log(peerIds)
158158

159159
A great source of [examples][] can be found in the tests for this API.
160160

161-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/pubsub
161+
[examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/pubsub

packages/interface-ipfs-core/SPEC/REFS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ for await (const ref of ipfs.refs.local()) {
9090
}
9191
```
9292

93-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/files-regular
93+
[examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/files-regular
9494
[b]: https://www.npmjs.com/package/buffer
9595
[cid]: https://www.npmjs.com/package/cids
9696
[blob]: https://developer.mozilla.org/en-US/docs/Web/API/Blob

packages/interface-ipfs-core/SPEC/STATS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,4 @@ for await (const stats of ipfs.stats.bw()) {
5858
A great source of [examples][] can be found in the tests for this API.
5959

6060
[bigNumber]: https://github.com/MikeMcl/bignumber.js/
61-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/stats
61+
[examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/stats

packages/interface-ipfs-core/SPEC/SWARM.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,4 +215,4 @@ Example:
215215
await ipfs.swarm.filters.rm(filter)
216216
```
217217

218-
[examples]: https://github.com/ipfs/interface-ipfs-core/blob/master/src/swarm
218+
[examples]: https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/src/swarm

0 commit comments

Comments
 (0)