diff --git a/examples/browser-add-readable-stream/README.md b/examples/browser-add-readable-stream/README.md index 700f1692..72dcf25d 100644 --- a/examples/browser-add-readable-stream/README.md +++ b/examples/browser-add-readable-stream/README.md @@ -29,6 +29,7 @@ - [Prerequisites](#prerequisites) - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -72,6 +73,16 @@ This example demonstrates the `Regular API`, top-level API for add, cat, get and _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) +- Tutorials: + - [MFS API](https://proto.school/mutable-file-system) + - [Regular File API](https://proto.school/regular-files-api) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-angular/README.md b/examples/browser-angular/README.md index c0e714c1..afdcff48 100644 --- a/examples/browser-angular/README.md +++ b/examples/browser-angular/README.md @@ -36,6 +36,7 @@ - [Running end-to-end tests](#running-end-to-end-tests) - [Further help](#further-help) - [Usage](#usage) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -105,6 +106,12 @@ Check the `ipfs.service.ts` file to how to use the basic of ipfs. _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-browserify/README.md b/examples/browser-browserify/README.md index eb2a2635..2b8830aa 100644 --- a/examples/browser-browserify/README.md +++ b/examples/browser-browserify/README.md @@ -29,6 +29,7 @@ - [Prerequisites](#prerequisites) - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -75,6 +76,16 @@ This example demonstrates the `Regular API`, top-level API for add, cat, get and _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) +- Tutorials: + - [MFS API](https://proto.school/mutable-file-system) + - [Regular File API](https://proto.school/regular-files-api) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-create-react-app/README.md b/examples/browser-create-react-app/README.md index 84ce7022..e83960ee 100755 --- a/examples/browser-create-react-app/README.md +++ b/examples/browser-create-react-app/README.md @@ -33,6 +33,7 @@ - [`npm test`](#npm-test) - [`npm run build`](#npm-run-build) - [Usage](#usage) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -115,6 +116,12 @@ Once the IPFS node is set up, `App.js` displays its ident and its version number _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-exchange-files/README.md b/examples/browser-exchange-files/README.md index 9c7a25a3..ee9bb635 100644 --- a/examples/browser-exchange-files/README.md +++ b/examples/browser-exchange-files/README.md @@ -37,6 +37,7 @@ - [5. Transfer files between all of your nodes!](#5-transfer-files-between-all-of-your-nodes) - [Going to production?](#going-to-production) - [Use your own `libp2p-webrtc-star` signaling server](#use-your-own-libp2p-webrtc-star-signaling-server) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -286,6 +287,19 @@ By default it will listen to all incoming connections on port 13579. Override th You should add your signaling server in the IPFS config swarm addresses, so that you listen for new connections through it. +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) + - [SWARM](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/SWARM.md) + - [PUBSUB](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/PUBSUB.md) + - [LIBP2P CONFIG](https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md) +- Tutorials: + - [Regular File API](https://proto.school/regular-files-api) + - [libp2p](https://proto.school/introduction-to-libp2p) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-ipns-publish/README.md b/examples/browser-ipns-publish/README.md index a773425b..fbce1f4c 100644 --- a/examples/browser-ipns-publish/README.md +++ b/examples/browser-ipns-publish/README.md @@ -32,6 +32,7 @@ - [Start two IPFS nodes](#start-two-ipfs-nodes) - [Install and start the Go IPFS node](#install-and-start-the-go-ipfs-node) - [Open the demo in a browser and connect to the go-node](#open-the-demo-in-a-browser-and-connect-to-the-go-node) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -128,6 +129,19 @@ Finally, enter `/ipfs/QmSomeHash` as the content you want to publish to IPNS. Yo _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [SWARM](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/SWARM.md) + - [PUBSUB](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/PUBSUB.md) + - [LIBP2P CONFIG](https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md) + - [IPFS-HTTP-CLIENT CONFIG](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-http-client#api) + - [IPNS](https://github.com/ipfs/js-ipns) +- Tutorials: + - [libp2p](https://proto.school/introduction-to-libp2p) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-lit/README.md b/examples/browser-lit/README.md index ae2fb195..c40912e1 100644 --- a/examples/browser-lit/README.md +++ b/examples/browser-lit/README.md @@ -29,6 +29,7 @@ - [Pre requisites](#pre-requisites) - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -70,6 +71,12 @@ This is a minimal demonstration of how to use `js-ipfs` in a lit app. _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-mfs/README.md b/examples/browser-mfs/README.md index 0ccc345e..d638dbef 100644 --- a/examples/browser-mfs/README.md +++ b/examples/browser-mfs/README.md @@ -29,6 +29,7 @@ - [Prerequisites](#prerequisites) - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -74,6 +75,16 @@ This demo allows you to upload files from your computer and use them to explore _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) +- Tutorials: + - [MFS API](https://proto.school/mutable-file-system) + - [Regular File API](https://proto.school/regular-files-api) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-nextjs/README.md b/examples/browser-nextjs/README.md index c1e2238b..58577743 100644 --- a/examples/browser-nextjs/README.md +++ b/examples/browser-nextjs/README.md @@ -34,6 +34,7 @@ - [Usage](#usage) - [Learn More](#learn-more) - [Deploy on Vercel](#deploy-on-vercel) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -111,6 +112,16 @@ Check out our [Next.js deployment documentation](https://nextjs.org/docs/deploym _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) +- Tutorials: + - [MFS API](https://proto.school/mutable-file-system) + - [Regular File API](https://proto.school/regular-files-api) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-parceljs/README.md b/examples/browser-parceljs/README.md index c7eb575f..d1ca7afb 100644 --- a/examples/browser-parceljs/README.md +++ b/examples/browser-parceljs/README.md @@ -29,6 +29,7 @@ - [Prerequisites](#prerequisites) - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -75,6 +76,16 @@ This example demonstrates the `Regular API`, top-level API for add, cat, get and _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) +- Tutorials: + - [MFS API](https://proto.school/mutable-file-system) + - [Regular File API](https://proto.school/regular-files-api) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-readablestream/README.md b/examples/browser-readablestream/README.md index 9ef1ab7e..9046c646 100644 --- a/examples/browser-readablestream/README.md +++ b/examples/browser-readablestream/README.md @@ -29,6 +29,7 @@ - [Prerequisites](#prerequisites) - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -70,6 +71,15 @@ Take a look at [`index.js`](./index.js) to see a working example. _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) +- Tutorials: + - [Regular File API](https://proto.school/regular-files-api) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-script-tag/README.md b/examples/browser-script-tag/README.md index 5a3160c4..4e66e35c 100644 --- a/examples/browser-script-tag/README.md +++ b/examples/browser-script-tag/README.md @@ -29,6 +29,7 @@ - [Prerequisites](#prerequisites) - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -74,6 +75,12 @@ This exposes a global `Ipfs`; you can get a node by making a `new Ipfs()`. _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-service-worker/README.md b/examples/browser-service-worker/README.md index c11cca97..d31c5dbf 100644 --- a/examples/browser-service-worker/README.md +++ b/examples/browser-service-worker/README.md @@ -34,6 +34,7 @@ - [`src/worker.js`](#srcworkerjs) - [`src/service.js`](#srcservicejs) - [Running example](#running-example) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -137,6 +138,17 @@ page from ipfs and appear as: _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [IPFS-MESSAGE-PORT-CLIENT](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-message-port-client) + - [IPFS-MESSAGE-PORT-PROTOCOL](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-message-port-protocol) + - [IPFS-MESSAGE-PORT-SERVER](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-message-port-server) +- Tutorials: + - [Anatomy of a CID](https://proto.school/anatomy-of-a-cid) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-sharing-node-across-tabs/README.md b/examples/browser-sharing-node-across-tabs/README.md index a9da6a4b..a7bcb2a0 100644 --- a/examples/browser-sharing-node-across-tabs/README.md +++ b/examples/browser-sharing-node-across-tabs/README.md @@ -29,6 +29,7 @@ - [Prerequisites](#prerequisites) - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -74,6 +75,16 @@ You should see the following: _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [IPFS-MESSAGE-PORT-CLIENT](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-message-port-client) + - [IPFS-MESSAGE-PORT-SERVER](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-message-port-server) +- Tutorials: + - [Anatomy of a CID](https://proto.school/anatomy-of-a-cid) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-video-streaming/README.md b/examples/browser-video-streaming/README.md index 14f89589..936f6b11 100644 --- a/examples/browser-video-streaming/README.md +++ b/examples/browser-video-streaming/README.md @@ -32,6 +32,7 @@ - [Why use HLS?](#why-use-hls) - [hlsjs-ipfs-loader](#hlsjs-ipfs-loader) - [Generating HLS content](#generating-hls-content) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -118,6 +119,12 @@ $ ipfs add -Qr . The most important piece of information to note down is the name you choose for the HLS manifest (master.m3u8 in this example, but you're free to use any name), and the hash returned by `ipfs add`. Consult [streaming.js](streaming.js) for a full example of how these values are used. +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-vue/README.md b/examples/browser-vue/README.md index 143ba595..e014b0dd 100644 --- a/examples/browser-vue/README.md +++ b/examples/browser-vue/README.md @@ -35,6 +35,7 @@ - [Lints and fixes files](#lints-and-fixes-files) - [Customize configuration](#customize-configuration) - [Usage](#usage) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -110,6 +111,12 @@ This project was bootstrapped with [Vue CLI](https://cli.vuejs.org/). _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/browser-webpack/README.md b/examples/browser-webpack/README.md index d7b05146..76a79303 100644 --- a/examples/browser-webpack/README.md +++ b/examples/browser-webpack/README.md @@ -29,6 +29,7 @@ - [Prerequisites](#prerequisites) - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -72,6 +73,16 @@ You should see the following: _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) +- Tutorials: + - [MFS API](https://proto.school/mutable-file-system) + - [Regular File API](https://proto.school/regular-files-api) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/circuit-relaying/CHANGELOG.md b/examples/circuit-relaying/CHANGELOG.md deleted file mode 100644 index 3a9f7f4e..00000000 --- a/examples/circuit-relaying/CHANGELOG.md +++ /dev/null @@ -1,67 +0,0 @@ -# Change Log - -All notable changes to this project will be documented in this file. -See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. - -## [0.1.1](https://github.com/ipfs/js-ipfs/compare/example-circuit-relaying@0.1.0...example-circuit-relaying@0.1.1) (2020-04-08) - -**Note:** Version bump only for package example-circuit-relaying - - - - - -# 0.1.0 (2020-03-31) - - -### Bug Fixes - -* fixing circuit-relaying example ([#1443](https://github.com/ipfs/js-ipfs/issues/1443)) ([a681fc5](https://github.com/ipfs/js-ipfs/commit/a681fc5aea835ee83adcf900efb5168e7e31cde8)), closes [#1423](https://github.com/ipfs/js-ipfs/issues/1423) -* typo ([#1367](https://github.com/ipfs/js-ipfs/issues/1367)) ([2679129](https://github.com/ipfs/js-ipfs/commit/267912959fc55b0ac90946b6ee46ff886799ea60)) - - -### chore - -* move mfs and multipart files into core ([#2811](https://github.com/ipfs/js-ipfs/issues/2811)) ([82b9e08](https://github.com/ipfs/js-ipfs/commit/82b9e085330e6c6290e6f3dd29678247984ffdce)) - - -### Code Refactoring - -* return peer IDs as strings not CIDs ([#2729](https://github.com/ipfs/js-ipfs/issues/2729)) ([16d540c](https://github.com/ipfs/js-ipfs/commit/16d540c540f375061d83dafaf6c38d0b7c4a3d60)) - - -### Features - -* (BREAKING CHANGE) new libp2p configuration ([#1401](https://github.com/ipfs/js-ipfs/issues/1401)) ([9c60909](https://github.com/ipfs/js-ipfs/commit/9c6090975521ae517b570f9479f696acf2d5371b)) -* Circuit Relay ([#1063](https://github.com/ipfs/js-ipfs/issues/1063)) ([f7eaa43](https://github.com/ipfs/js-ipfs/commit/f7eaa4321de2d8137086ac750104a0671f156a47)) -* gossipsub as default pubsub ([#2298](https://github.com/ipfs/js-ipfs/issues/2298)) ([902e045](https://github.com/ipfs/js-ipfs/commit/902e04547e8cd0aaee994193ef664f662ff07683)) -* mfs implementation ([#1360](https://github.com/ipfs/js-ipfs/issues/1360)) ([871d24e](https://github.com/ipfs/js-ipfs/commit/871d24e35c402956e2297350342268528c3192db)), closes [#1425](https://github.com/ipfs/js-ipfs/issues/1425) - - -### BREAKING CHANGES - -* When the path passed to `ipfs.files.stat(path)` was a hamt sharded dir, the resovled -value returned by js-ipfs previously had a `type` property of with a value of -`'hamt-sharded-directory'`. To bring it in line with go-ipfs this value is now -`'directory'`. -* Where `PeerID`s were previously [CID](https://www.npmjs.com/package/cids)s, now they are Strings - -- `ipfs.bitswap.stat().peers[n]` is now a String (was a CID) -- `ipfs.dht.findPeer().id` is now a String (was a CID) -- `ipfs.dht.findProvs()[n].id` is now a String (was a CID) -- `ipfs.dht.provide()[n].id` is now a String (was a CID) -- `ipfs.dht.put()[n].id` is now a String (was a CID) -- `ipfs.dht.query()[n].id` is now a String (was a CID) -- `ipfs.id().id` is now a String (was a CID) -- `ipfs.id().addresses[n]` are now [Multiaddr](https://www.npmjs.com/package/multiaddr)s (were Strings) -* The default pubsub implementation has changed from floodsub to [gossipsub](https://github.com/ChainSafe/gossipsub-js). Additionally, to enable pubsub programmatically set `pubsub.enabled: true` instead of `EXPERIMENTAL.pubsub: true` or via the CLI pass `--enable-pubsub` instead of `--enable-pubsub-experiment` to `jsipfs daemon`. -* libp2p configuration has changed - - * old: `libp2p.modules.discovery` - * new: `libp2p.modules.peerDiscovery` - -License: MIT -Signed-off-by: David Dias - -License: MIT -Signed-off-by: Alan Shaw diff --git a/examples/circuit-relaying/README.md b/examples/circuit-relaying/README.md index b7b3e04a..70543cbb 100644 --- a/examples/circuit-relaying/README.md +++ b/examples/circuit-relaying/README.md @@ -44,6 +44,7 @@ - [4. Dial the two browser nodes using a `/p2p-circuit` address](#4-dial-the-two-browser-nodes-using-a-p2p-circuit-address) - [5. Send data browser to browser.](#5-send-data-browser-to-browser) - [So what just happened?](#so-what-just-happened) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -398,6 +399,18 @@ Cheers! _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [SWARM](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/SWARM.md) + - [PUBSUB](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/PUBSUB.md) + - [LIBP2P CONFIG](https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md) +- Tutorials: + - [libp2p](https://proto.school/introduction-to-libp2p) + - [Anatomy of a CID](https://proto.school/anatomy-of-a-cid) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/custom-ipfs-repo/CHANGELOG.md b/examples/custom-ipfs-repo/CHANGELOG.md deleted file mode 100644 index c9dc1ed0..00000000 --- a/examples/custom-ipfs-repo/CHANGELOG.md +++ /dev/null @@ -1,38 +0,0 @@ -# Change Log - -All notable changes to this project will be documented in this file. -See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. - -## [0.2.1](https://github.com/ipfs/js-ipfs/compare/example-custom-ipfs-repo@0.2.0...example-custom-ipfs-repo@0.2.1) (2020-04-08) - -**Note:** Version bump only for package example-custom-ipfs-repo - - - - - -# 0.2.0 (2020-03-31) - - -### Bug Fixes - -* examples after files API refactor ([#1740](https://github.com/ipfs/js-ipfs/issues/1740)) ([34ec036](https://github.com/ipfs/js-ipfs/commit/34ec036b0df9563a014c1348f0a056c1f98aadad)) - - -### Code Refactoring - -* return peer IDs as strings not CIDs ([#2729](https://github.com/ipfs/js-ipfs/issues/2729)) ([16d540c](https://github.com/ipfs/js-ipfs/commit/16d540c540f375061d83dafaf6c38d0b7c4a3d60)) - - -### BREAKING CHANGES - -* Where `PeerID`s were previously [CID](https://www.npmjs.com/package/cids)s, now they are Strings - -- `ipfs.bitswap.stat().peers[n]` is now a String (was a CID) -- `ipfs.dht.findPeer().id` is now a String (was a CID) -- `ipfs.dht.findProvs()[n].id` is now a String (was a CID) -- `ipfs.dht.provide()[n].id` is now a String (was a CID) -- `ipfs.dht.put()[n].id` is now a String (was a CID) -- `ipfs.dht.query()[n].id` is now a String (was a CID) -- `ipfs.id().id` is now a String (was a CID) -- `ipfs.id().addresses[n]` are now [Multiaddr](https://www.npmjs.com/package/multiaddr)s (were Strings) diff --git a/examples/custom-ipfs-repo/README.md b/examples/custom-ipfs-repo/README.md index 82cf42ff..e8ee320a 100644 --- a/examples/custom-ipfs-repo/README.md +++ b/examples/custom-ipfs-repo/README.md @@ -31,6 +31,7 @@ - [Usage](#usage) - [Custom `storageBackends`](#custom-storagebackends) - [Custom Repo Lock](#custom-repo-lock) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -90,6 +91,17 @@ const repo = new Repo('/tmp/.ipfs', { _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS REPO](https://github.com/ipfs/js-ipfs-repo#setup) + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) +- Tutorials: + - [Regular File API](https://proto.school/regular-files-api) + - [libp2p](https://proto.school/introduction-to-libp2p) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/custom-ipld-formats/README.md b/examples/custom-ipld-formats/README.md index 77fe56cb..d755035e 100644 --- a/examples/custom-ipld-formats/README.md +++ b/examples/custom-ipld-formats/README.md @@ -30,6 +30,7 @@ - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) - [Play with the configuration!](#play-with-the-configuration) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -76,6 +77,19 @@ See the following files for different configuration: _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [DAG](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/DAG.md) + - [IPFS-HTTP-CLIENT CONFIG](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-http-client#api) + - [DAEMON](https://github.com/ipfs/js-ipfs/blob/master/docs/DAEMON.md) + - [MULTIFORMATS](https://github.com/multiformats/js-multiformats) + - [IPLD](https://github.com/ipfs/js-ipfs/blob/master/docs/IPLD.md) +- Tutorials: + - [Merkle DAGs](https://proto.school/merkle-dags) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/custom-libp2p/CHANGELOG.md b/examples/custom-libp2p/CHANGELOG.md deleted file mode 100644 index d3ed19d5..00000000 --- a/examples/custom-libp2p/CHANGELOG.md +++ /dev/null @@ -1,46 +0,0 @@ -# Change Log - -All notable changes to this project will be documented in this file. -See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. - -## [0.2.1](https://github.com/ipfs/js-ipfs/compare/example-custom-libp2p@0.2.0...example-custom-libp2p@0.2.1) (2020-04-08) - -**Note:** Version bump only for package example-custom-libp2p - - - - - -# 0.2.0 (2020-03-31) - - -### Bug Fixes - -* **package:** update libp2p-kad-dht to version 0.15.0 ([#2049](https://github.com/ipfs/js-ipfs/issues/2049)) ([5905760](https://github.com/ipfs/js-ipfs/commit/59057609784ec6ca04625003e0e765f3141418ac)) - - -### Code Refactoring - -* return peer IDs as strings not CIDs ([#2729](https://github.com/ipfs/js-ipfs/issues/2729)) ([16d540c](https://github.com/ipfs/js-ipfs/commit/16d540c540f375061d83dafaf6c38d0b7c4a3d60)) - - -### Features - -* add libp2p factory config option with example ([#1470](https://github.com/ipfs/js-ipfs/issues/1470)) ([46222e1](https://github.com/ipfs/js-ipfs/commit/46222e1093b8919f572fd948612bd436a4376e31)), closes [#1463](https://github.com/ipfs/js-ipfs/issues/1463) -* gossipsub as default pubsub ([#2298](https://github.com/ipfs/js-ipfs/issues/2298)) ([902e045](https://github.com/ipfs/js-ipfs/commit/902e04547e8cd0aaee994193ef664f662ff07683)) -* use libp2p auto dial ([#1983](https://github.com/ipfs/js-ipfs/issues/1983)) ([7f1fb26](https://github.com/ipfs/js-ipfs/commit/7f1fb263788dbd2c07766949fb9150319887f666)) - - -### BREAKING CHANGES - -* Where `PeerID`s were previously [CID](https://www.npmjs.com/package/cids)s, now they are Strings - -- `ipfs.bitswap.stat().peers[n]` is now a String (was a CID) -- `ipfs.dht.findPeer().id` is now a String (was a CID) -- `ipfs.dht.findProvs()[n].id` is now a String (was a CID) -- `ipfs.dht.provide()[n].id` is now a String (was a CID) -- `ipfs.dht.put()[n].id` is now a String (was a CID) -- `ipfs.dht.query()[n].id` is now a String (was a CID) -- `ipfs.id().id` is now a String (was a CID) -- `ipfs.id().addresses[n]` are now [Multiaddr](https://www.npmjs.com/package/multiaddr)s (were Strings) -* The default pubsub implementation has changed from floodsub to [gossipsub](https://github.com/ChainSafe/gossipsub-js). Additionally, to enable pubsub programmatically set `pubsub.enabled: true` instead of `EXPERIMENTAL.pubsub: true` or via the CLI pass `--enable-pubsub` instead of `--enable-pubsub-experiment` to `jsipfs daemon`. diff --git a/examples/custom-libp2p/README.md b/examples/custom-libp2p/README.md index b54ce16a..9bf5fd16 100644 --- a/examples/custom-libp2p/README.md +++ b/examples/custom-libp2p/README.md @@ -30,6 +30,7 @@ - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) - [Play with the configuration!](#play-with-the-configuration) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -73,6 +74,16 @@ This is also a good opportunity to explore the various stats that ipfs offers! N _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [SWARM](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/SWARM.md) + - [STATS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/STATS.md) + - [LIBP2P CONFIG](https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md) +- Examples: + - [LIBP2P Examples](https://github.com/libp2p/js-libp2p/tree/master/examples) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/http-client-browser-pubsub/README.md b/examples/http-client-browser-pubsub/README.md index 50d7bc3d..67203eac 100644 --- a/examples/http-client-browser-pubsub/README.md +++ b/examples/http-client-browser-pubsub/README.md @@ -34,6 +34,7 @@ - [JS IPFS node](#js-ipfs-node) - [GO IPFS node](#go-ipfs-node) - [3. Open two browsers and connect to each node](#3-open-two-browsers-and-connect-to-each-node) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -142,6 +143,15 @@ Finally, use the "SUBSCRIBE TO PUBSUB TOPIC" and "SEND MESSAGE" fields to do som _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [SWARM](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/SWARM.md) + - [PUBSUB](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/PUBSUB.md) + - [IPFS-HTTP-CLIENT CONFIG](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-http-client#api) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/http-client-bundle-webpack/README.md b/examples/http-client-bundle-webpack/README.md index cad1d412..83094e81 100644 --- a/examples/http-client-bundle-webpack/README.md +++ b/examples/http-client-bundle-webpack/README.md @@ -30,6 +30,7 @@ - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) - [Setup](#setup) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -90,6 +91,13 @@ You should see the following: _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [IPFS-HTTP-CLIENT CONFIG](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-http-client#api) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/http-client-name-api/README.md b/examples/http-client-name-api/README.md index 7df1987f..41534a65 100644 --- a/examples/http-client-name-api/README.md +++ b/examples/http-client-name-api/README.md @@ -30,6 +30,7 @@ - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) - [Setup](#setup) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -89,6 +90,17 @@ A quick (and dirty) way to get it done is: _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) + - [IPFS-HTTP-CLIENT CONFIG](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-http-client#api) +- Tutorials: + - [MFS API](https://proto.school/mutable-file-system) + - [Regular File API](https://proto.school/regular-files-api) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/http-client-upload-file/README.md b/examples/http-client-upload-file/README.md index 5743c438..8ddb1271 100644 --- a/examples/http-client-upload-file/README.md +++ b/examples/http-client-upload-file/README.md @@ -30,6 +30,7 @@ - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) - [Setup](#setup) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -90,6 +91,17 @@ You should see the following: _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) + - [IPFS-HTTP-CLIENT CONFIG](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-http-client#api) +- Tutorials: + - [MFS API](https://proto.school/mutable-file-system) + - [Regular File API](https://proto.school/regular-files-api) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/ipfs-101/README.md b/examples/ipfs-101/README.md index 3c11172f..22a3d16b 100644 --- a/examples/ipfs-101/README.md +++ b/examples/ipfs-101/README.md @@ -30,6 +30,7 @@ - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) - [Code analysis](#code-analysis) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -178,6 +179,16 @@ That's it! You just added and retrieved a file from the Distributed Web! _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) +- Tutorials: + - [MFS API](https://proto.school/mutable-file-system) + - [Regular File API](https://proto.school/regular-files-api) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/ipfs-client-add-files/README.md b/examples/ipfs-client-add-files/README.md index 09e6966d..07089727 100644 --- a/examples/ipfs-client-add-files/README.md +++ b/examples/ipfs-client-add-files/README.md @@ -30,6 +30,7 @@ - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) - [Setup](#setup) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -86,6 +87,17 @@ A quick (and dirty way to get it done) is: _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + - [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) + - [IPFS-CLIENT CONFIG](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-client) +- Tutorials: + - [MFS API](https://proto.school/mutable-file-system) + - [Regular File API](https://proto.school/regular-files-api) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/run-in-electron/README.md b/examples/run-in-electron/README.md index e0e82896..eb5bd6e5 100755 --- a/examples/run-in-electron/README.md +++ b/examples/run-in-electron/README.md @@ -29,6 +29,7 @@ - [Prerequisites](#prerequisites) - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -66,6 +67,12 @@ This example is heavily inspired by [electron-quick-start](https://github.com/el _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/running-multiple-nodes/README.md b/examples/running-multiple-nodes/README.md index b3778183..e74df59d 100644 --- a/examples/running-multiple-nodes/README.md +++ b/examples/running-multiple-nodes/README.md @@ -31,6 +31,7 @@ - [Usage](#usage) - [Via the CLI](#via-the-cli) - [Programmatically](#programmatically) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -129,6 +130,12 @@ await IPFS.create({ _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/traverse-ipld-graphs/README.md b/examples/traverse-ipld-graphs/README.md index d5f7cb43..e7eb8e15 100644 --- a/examples/traverse-ipld-graphs/README.md +++ b/examples/traverse-ipld-graphs/README.md @@ -37,6 +37,7 @@ - [traverse through a slice of the ethereum blockchain](#traverse-through-a-slice-of-the-ethereum-blockchain) - [traverse through a git repo](#traverse-through-a-git-repo) - [Video of the demos](#video-of-the-demos) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -124,6 +125,17 @@ Find a video with a walkthrough of this examples on Youtube: _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [DAG](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/DAG.md) + - [BLOCK](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/BLOCK.md) + - [MULTIFORMATS](https://github.com/multiformats/js-multiformats) + - [IPLD](https://github.com/ipfs/js-ipfs/blob/master/docs/IPLD.md) +- Tutorials: + - [Merkle DAGs](https://proto.school/merkle-dags) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/types-use-ipfs-from-ts/README.md b/examples/types-use-ipfs-from-ts/README.md index 9b4ff99f..9de45f60 100644 --- a/examples/types-use-ipfs-from-ts/README.md +++ b/examples/types-use-ipfs-from-ts/README.md @@ -31,6 +31,7 @@ - [Usage](#usage) - [IntelliSense](#intellisense) - [Limitations](#limitations) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -100,6 +101,12 @@ In [VSCode](https://code.visualstudio.com/) and other code editors that provide _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + ## Documentation - [Config](https://docs.ipfs.io/) diff --git a/examples/types-use-ipfs-from-typed-js/README.md b/examples/types-use-ipfs-from-typed-js/README.md index 303e3496..d84a772c 100644 --- a/examples/types-use-ipfs-from-typed-js/README.md +++ b/examples/types-use-ipfs-from-typed-js/README.md @@ -32,6 +32,7 @@ - [Type checking](#type-checking) - [IntelliSense](#intellisense) - [Limitations](#limitations) +- [References](#references) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -117,6 +118,12 @@ In [VSCode](https://code.visualstudio.com/) and other code editors that provide _For more examples, please refer to the [Documentation](#documentation)_ +## References + +- Documentation: + - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md) + - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md) + ## Documentation - [Config](https://docs.ipfs.io/)