feat: add references to doc/tutorials/examples

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/)

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/)

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/)

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/)

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/)

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/)

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/)

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/)

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/)

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/)

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/)

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/)

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/)

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/)

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/)

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/)