Skip to content

Commit 079bdac

Browse files
chore: move examples to external repo (#3821)
- Removes all the examples from this repository - Change CI to execute the test examples from external repo (https://github.com/ipfs-examples/js-ipfs-examples.git) - Update `.md` files and add links to point to the new examples org/repos - Remove scripts related with example tests
1 parent 6b7ca2f commit 079bdac

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,8 @@ Alternatively it can be an object which may have the following keys:
118118
#### Returns
119119

120120
| Type | Description |
121-
| -------- | -------- |
122-
| `Object` | An object that conforms to the [IPFS Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) |
121+
| ---- | ----------- |
122+
| `Object` | An object that conforms to the [IPFS Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) |
123123

124124
#### Example
125125

@@ -284,11 +284,11 @@ const ipfs = create({ host: '1.1.1.1', port: '80', apiPath: '/ipfs/api/v0' })
284284

285285
Same as in Node.js, you just have to [browserify](http://browserify.org) the code before serving it. See the browserify repo for how to do that.
286286

287-
See the example in the [examples folder](/examples/http-client-browser-browserify) to get a boilerplate.
287+
See the example in the [examples folder](https://github.com/ipfs-examples/js-ipfs-examples/tree/master/examples) to get a boilerplate.
288288

289289
**through webpack**
290290

291-
See the example in the [examples folder](/examples/http-client-bundle-webpack) to get an idea on how to use `js-ipfs-http-client` with webpack.
291+
See the example in the [examples folder](https://github.com/ipfs-examples/js-ipfs-examples/tree/master/examples/http-client-bundle-webpack) to get an idea on how to use `js-ipfs-http-client` with webpack.
292292

293293
**from CDN**
294294

@@ -310,9 +310,11 @@ For maximum security you may also decide to:
310310
Example:
311311

312312
```html
313-
<script src="https://www.jsdelivr.com/package/npm/ipfs-http-client"
314-
integrity="sha384-5bXRcW9kyxxnSMbOoHzraqa7Z0PQWIao+cgeg327zit1hz5LZCEbIMx/LWKPReuB"
315-
crossorigin="anonymous"></script>
313+
<script
314+
src="https://www.jsdelivr.com/package/npm/ipfs-http-client"
315+
integrity="sha384-5bXRcW9kyxxnSMbOoHzraqa7Z0PQWIao+cgeg327zit1hz5LZCEbIMx/LWKPReuB"
316+
crossorigin="anonymous"
317+
></script>
316318
```
317319

318320
CDN-based IPFS API provides the `IpfsHttpClient` constructor as a method of the global `window` object. Example:

0 commit comments

Comments
 (0)