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

Commit 0ed87d6

Browse files
oliveriosousaoliveriosousa
authored
feat: add references to doc/tutorials/examples (#34)
1 parent 52c8c6d commit 0ed87d6

File tree

35 files changed

+324
-151
lines changed

35 files changed

+324
-151
lines changed

‎examples/browser-add-readable-stream/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
- [Prerequisites](#prerequisites)
3030
- [Installation and Running example](#installation-and-running-example)
3131
- [Usage](#usage)
32+
- [References](#references)
3233
- [Documentation](#documentation)
3334
- [Contributing](#contributing)
3435
- [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
7273

7374
_For more examples, please refer to the [Documentation](#documentation)_
7475

76+
## References
77+
78+
- Documentation:
79+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
80+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
81+
- [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md)
82+
- Tutorials:
83+
- [MFS API](https://proto.school/mutable-file-system)
84+
- [Regular File API](https://proto.school/regular-files-api)
85+
7586
## Documentation
7687

7788
- [Config](https://docs.ipfs.io/)

‎examples/browser-angular/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636
- [Running end-to-end tests](#running-end-to-end-tests)
3737
- [Further help](#further-help)
3838
- [Usage](#usage)
39+
- [References](#references)
3940
- [Documentation](#documentation)
4041
- [Contributing](#contributing)
4142
- [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.
105106

106107
_For more examples, please refer to the [Documentation](#documentation)_
107108

109+
## References
110+
111+
- Documentation:
112+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
113+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
114+
108115
## Documentation
109116

110117
- [Config](https://docs.ipfs.io/)

‎examples/browser-browserify/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
- [Prerequisites](#prerequisites)
3030
- [Installation and Running example](#installation-and-running-example)
3131
- [Usage](#usage)
32+
- [References](#references)
3233
- [Documentation](#documentation)
3334
- [Contributing](#contributing)
3435
- [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
7576

7677
_For more examples, please refer to the [Documentation](#documentation)_
7778

79+
## References
80+
81+
- Documentation:
82+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
83+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
84+
- [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md)
85+
- Tutorials:
86+
- [MFS API](https://proto.school/mutable-file-system)
87+
- [Regular File API](https://proto.school/regular-files-api)
88+
7889
## Documentation
7990

8091
- [Config](https://docs.ipfs.io/)

‎examples/browser-create-react-app/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
- [`npm test`](#npm-test)
3434
- [`npm run build`](#npm-run-build)
3535
- [Usage](#usage)
36+
- [References](#references)
3637
- [Documentation](#documentation)
3738
- [Contributing](#contributing)
3839
- [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
115116

116117
_For more examples, please refer to the [Documentation](#documentation)_
117118

119+
## References
120+
121+
- Documentation:
122+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
123+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
124+
118125
## Documentation
119126

120127
- [Config](https://docs.ipfs.io/)

‎examples/browser-exchange-files/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
- [5. Transfer files between all of your nodes!](#5-transfer-files-between-all-of-your-nodes)
3838
- [Going to production?](#going-to-production)
3939
- [Use your own `libp2p-webrtc-star` signaling server](#use-your-own-libp2p-webrtc-star-signaling-server)
40+
- [References](#references)
4041
- [Documentation](#documentation)
4142
- [Contributing](#contributing)
4243
- [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
286287

287288
You should add your signaling server in the IPFS config swarm addresses, so that you listen for new connections through it.
288289

290+
## References
291+
292+
- Documentation:
293+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
294+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
295+
- [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md)
296+
- [SWARM](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/SWARM.md)
297+
- [PUBSUB](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/PUBSUB.md)
298+
- [LIBP2P CONFIG](https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md)
299+
- Tutorials:
300+
- [Regular File API](https://proto.school/regular-files-api)
301+
- [libp2p](https://proto.school/introduction-to-libp2p)
302+
289303
## Documentation
290304

291305
- [Config](https://docs.ipfs.io/)

‎examples/browser-ipns-publish/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
- [Start two IPFS nodes](#start-two-ipfs-nodes)
3333
- [Install and start the Go IPFS node](#install-and-start-the-go-ipfs-node)
3434
- [Open the demo in a browser and connect to the go-node](#open-the-demo-in-a-browser-and-connect-to-the-go-node)
35+
- [References](#references)
3536
- [Documentation](#documentation)
3637
- [Contributing](#contributing)
3738
- [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
128129

129130
_For more examples, please refer to the [Documentation](#documentation)_
130131

132+
## References
133+
134+
- Documentation:
135+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
136+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
137+
- [SWARM](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/SWARM.md)
138+
- [PUBSUB](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/PUBSUB.md)
139+
- [LIBP2P CONFIG](https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md)
140+
- [IPFS-HTTP-CLIENT CONFIG](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-http-client#api)
141+
- [IPNS](https://github.com/ipfs/js-ipns)
142+
- Tutorials:
143+
- [libp2p](https://proto.school/introduction-to-libp2p)
144+
131145
## Documentation
132146

133147
- [Config](https://docs.ipfs.io/)

‎examples/browser-lit/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
- [Pre requisites](#pre-requisites)
3030
- [Installation and Running example](#installation-and-running-example)
3131
- [Usage](#usage)
32+
- [References](#references)
3233
- [Documentation](#documentation)
3334
- [Contributing](#contributing)
3435
- [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.
7071

7172
_For more examples, please refer to the [Documentation](#documentation)_
7273

74+
## References
75+
76+
- Documentation:
77+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
78+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
79+
7380
## Documentation
7481

7582
- [Config](https://docs.ipfs.io/)

‎examples/browser-mfs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
- [Prerequisites](#prerequisites)
3030
- [Installation and Running example](#installation-and-running-example)
3131
- [Usage](#usage)
32+
- [References](#references)
3233
- [Documentation](#documentation)
3334
- [Contributing](#contributing)
3435
- [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
7475

7576
_For more examples, please refer to the [Documentation](#documentation)_
7677

78+
## References
79+
80+
- Documentation:
81+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
82+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
83+
- [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md)
84+
- Tutorials:
85+
- [MFS API](https://proto.school/mutable-file-system)
86+
- [Regular File API](https://proto.school/regular-files-api)
87+
7788
## Documentation
7889

7990
- [Config](https://docs.ipfs.io/)

‎examples/browser-nextjs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
- [Usage](#usage)
3535
- [Learn More](#learn-more)
3636
- [Deploy on Vercel](#deploy-on-vercel)
37+
- [References](#references)
3738
- [Documentation](#documentation)
3839
- [Contributing](#contributing)
3940
- [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
111112

112113
_For more examples, please refer to the [Documentation](#documentation)_
113114

115+
## References
116+
117+
- Documentation:
118+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
119+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
120+
- [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md)
121+
- Tutorials:
122+
- [MFS API](https://proto.school/mutable-file-system)
123+
- [Regular File API](https://proto.school/regular-files-api)
124+
114125
## Documentation
115126

116127
- [Config](https://docs.ipfs.io/)

‎examples/browser-parceljs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
- [Prerequisites](#prerequisites)
3030
- [Installation and Running example](#installation-and-running-example)
3131
- [Usage](#usage)
32+
- [References](#references)
3233
- [Documentation](#documentation)
3334
- [Contributing](#contributing)
3435
- [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
7576

7677
_For more examples, please refer to the [Documentation](#documentation)_
7778

79+
## References
80+
81+
- Documentation:
82+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
83+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
84+
- [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md)
85+
- Tutorials:
86+
- [MFS API](https://proto.school/mutable-file-system)
87+
- [Regular File API](https://proto.school/regular-files-api)
88+
7889
## Documentation
7990

8091
- [Config](https://docs.ipfs.io/)

‎examples/browser-readablestream/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
- [Prerequisites](#prerequisites)
3030
- [Installation and Running example](#installation-and-running-example)
3131
- [Usage](#usage)
32+
- [References](#references)
3233
- [Documentation](#documentation)
3334
- [Contributing](#contributing)
3435
- [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.
7071

7172
_For more examples, please refer to the [Documentation](#documentation)_
7273

74+
## References
75+
76+
- Documentation:
77+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
78+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
79+
- [FILES](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md)
80+
- Tutorials:
81+
- [Regular File API](https://proto.school/regular-files-api)
82+
7383
## Documentation
7484

7585
- [Config](https://docs.ipfs.io/)

‎examples/browser-script-tag/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
- [Prerequisites](#prerequisites)
3030
- [Installation and Running example](#installation-and-running-example)
3131
- [Usage](#usage)
32+
- [References](#references)
3233
- [Documentation](#documentation)
3334
- [Contributing](#contributing)
3435
- [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()`.
7475

7576
_For more examples, please refer to the [Documentation](#documentation)_
7677

78+
## References
79+
80+
- Documentation:
81+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
82+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
83+
7784
## Documentation
7885

7986
- [Config](https://docs.ipfs.io/)

‎examples/browser-service-worker/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
- [`src/worker.js`](#srcworkerjs)
3535
- [`src/service.js`](#srcservicejs)
3636
- [Running example](#running-example)
37+
- [References](#references)
3738
- [Documentation](#documentation)
3839
- [Contributing](#contributing)
3940
- [Want to hack on IPFS?](#want-to-hack-on-ipfs)
@@ -137,6 +138,17 @@ page from ipfs and appear as:
137138

138139
_For more examples, please refer to the [Documentation](#documentation)_
139140

141+
## References
142+
143+
- Documentation:
144+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
145+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
146+
- [IPFS-MESSAGE-PORT-CLIENT](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-message-port-client)
147+
- [IPFS-MESSAGE-PORT-PROTOCOL](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-message-port-protocol)
148+
- [IPFS-MESSAGE-PORT-SERVER](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-message-port-server)
149+
- Tutorials:
150+
- [Anatomy of a CID](https://proto.school/anatomy-of-a-cid)
151+
140152
## Documentation
141153

142154
- [Config](https://docs.ipfs.io/)

‎examples/browser-sharing-node-across-tabs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
- [Prerequisites](#prerequisites)
3030
- [Installation and Running example](#installation-and-running-example)
3131
- [Usage](#usage)
32+
- [References](#references)
3233
- [Documentation](#documentation)
3334
- [Contributing](#contributing)
3435
- [Want to hack on IPFS?](#want-to-hack-on-ipfs)
@@ -74,6 +75,16 @@ You should see the following:
7475

7576
_For more examples, please refer to the [Documentation](#documentation)_
7677

78+
## References
79+
80+
- Documentation:
81+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
82+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
83+
- [IPFS-MESSAGE-PORT-CLIENT](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-message-port-client)
84+
- [IPFS-MESSAGE-PORT-SERVER](https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-message-port-server)
85+
- Tutorials:
86+
- [Anatomy of a CID](https://proto.school/anatomy-of-a-cid)
87+
7788
## Documentation
7889

7990
- [Config](https://docs.ipfs.io/)

‎examples/browser-video-streaming/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
- [Why use HLS?](#why-use-hls)
3333
- [hlsjs-ipfs-loader](#hlsjs-ipfs-loader)
3434
- [Generating HLS content](#generating-hls-content)
35+
- [References](#references)
3536
- [Documentation](#documentation)
3637
- [Contributing](#contributing)
3738
- [Want to hack on IPFS?](#want-to-hack-on-ipfs)
@@ -118,6 +119,12 @@ $ ipfs add -Qr .
118119

119120
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.
120121

122+
## References
123+
124+
- Documentation:
125+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
126+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
127+
121128
## Documentation
122129

123130
- [Config](https://docs.ipfs.io/)

‎examples/browser-vue/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
- [Lints and fixes files](#lints-and-fixes-files)
3636
- [Customize configuration](#customize-configuration)
3737
- [Usage](#usage)
38+
- [References](#references)
3839
- [Documentation](#documentation)
3940
- [Contributing](#contributing)
4041
- [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/).
110111

111112
_For more examples, please refer to the [Documentation](#documentation)_
112113

114+
## References
115+
116+
- Documentation:
117+
- [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)
118+
- [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)
119+
113120
## Documentation
114121

115122
- [Config](https://docs.ipfs.io/)

0 commit comments

Comments
 (0)