diff --git a/README.md b/README.md index 97abc49a..49a676e4 100644 --- a/README.md +++ b/README.md @@ -7,17 +7,17 @@

JS IPFS Examples

- Collection of js-ipfs examples -
-
- -
- Explore the docs - · - Report Bug - · - Request Feature/Example -

+ Collection of js-ipfs examples +
+
+ +
+ Explore the docs + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -35,7 +35,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -82,8 +82,9 @@ Explore [ProtoSchool's IPFS tutorials](https://proto.school/#/tutorials?course=i - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-add-readable-stream/README.md b/examples/browser-add-readable-stream/README.md index 673fe014..700f1692 100644 --- a/examples/browser-add-readable-stream/README.md +++ b/examples/browser-add-readable-stream/README.md @@ -7,19 +7,19 @@

Readable Stream

- Using duplex streams to add files to IPFS in the browser -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Using duplex streams to add files to IPFS in the browser +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -36,7 +36,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -76,8 +76,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-angular/README.md b/examples/browser-angular/README.md index d8c00cb3..c0e714c1 100644 --- a/examples/browser-angular/README.md +++ b/examples/browser-angular/README.md @@ -7,19 +7,19 @@

IPFS React App

- Using js-ipfs in a `create-react-app` -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature -

+ Using js-ipfs in a `create-react-app` +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature +

## Table of Contents @@ -43,7 +43,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -67,7 +67,7 @@ Make sure you have installed all of the following prerequisites on your developm > npm start ``` -Now open your browser at `http://localhost:3000` +Now open your browser at `http://localhost:4200` ### Available Scripts from create-react-app @@ -109,8 +109,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-browserify/README.md b/examples/browser-browserify/README.md index 3878776b..eb2a2635 100644 --- a/examples/browser-browserify/README.md +++ b/examples/browser-browserify/README.md @@ -7,19 +7,19 @@

js-ipfs with browserify

- Bundle js-ipfs with Browserify! -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Bundle js-ipfs with Browserify! +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -36,7 +36,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -79,8 +79,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-create-react-app/README.md b/examples/browser-create-react-app/README.md index fdcf3bf9..84ce7022 100755 --- a/examples/browser-create-react-app/README.md +++ b/examples/browser-create-react-app/README.md @@ -7,19 +7,19 @@

IPFS React App

- Using js-ipfs in a `create-react-app` -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Using js-ipfs in a `create-react-app` +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -40,7 +40,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -119,8 +119,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-exchange-files/README.md b/examples/browser-exchange-files/README.md index e2d98045..9c7a25a3 100644 --- a/examples/browser-exchange-files/README.md +++ b/examples/browser-exchange-files/README.md @@ -7,45 +7,44 @@

Exchange files with js-ipfs

- Exchange files between the browser and other IPFS nodes -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Exchange files between the browser and other IPFS nodes +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents -- [](#) - - [Table of Contents](#table-of-contents) - - [About The Project](#about-the-project) - - [Getting Started](#getting-started) - - [Pre requisites](#pre-requisites) - - [Installation and Running example](#installation-and-running-example) - - [Usage](#usage) - - [Step-by-step instructions](#step-by-step-instructions) - - [1. Install `go-ipfs` or `js-ipfs`](#1-install-go-ipfs-or-js-ipfs) - - [2. Make your daemons listen on WebSockets](#2-make-your-daemons-listen-on-websockets) - - [3. Start the app](#3-start-the-app) - - [4. Dial to a node using WebSockets (your desktop ones)](#4-dial-to-a-node-using-websockets-your-desktop-ones) - - [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) - - [Documentation](#documentation) - - [Contributing](#contributing) - - [Want to hack on IPFS?](#want-to-hack-on-ipfs) +- [Table of Contents](#table-of-contents) +- [About The Project](#about-the-project) +- [Getting Started](#getting-started) + - [Pre requisites](#pre-requisites) + - [Installation and Running example](#installation-and-running-example) +- [Usage](#usage) + - [Step-by-step instructions](#step-by-step-instructions) + - [1. Install `go-ipfs` or `js-ipfs`](#1-install-go-ipfs-or-js-ipfs) + - [2. Make your daemons listen on WebSockets](#2-make-your-daemons-listen-on-websockets) + - [3. Start the app](#3-start-the-app) + - [4. Dial to a node using WebSockets (your desktop ones)](#4-dial-to-a-node-using-websockets-your-desktop-ones) + - [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) +- [Documentation](#documentation) +- [Contributing](#contributing) +- [Want to hack on IPFS?](#want-to-hack-on-ipfs) ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -192,12 +191,10 @@ Check the `/ws` in line 5, that means it is listening. Cool. ### 3. Start the app -Make sure you're in `js-ipfs/examples/exchange-files-in-browser`. - We'll need to bundle the dependencies to run the app. Let's do it: ```sh -> npm run bundle +> npm run build ... > npm start ``` @@ -293,8 +290,9 @@ You should add your signaling server in the IPFS config swarm addresses, so that - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-ipns-publish/README.md b/examples/browser-ipns-publish/README.md index 033a5d7b..a773425b 100644 --- a/examples/browser-ipns-publish/README.md +++ b/examples/browser-ipns-publish/README.md @@ -7,19 +7,19 @@

Publish to IPNS

- Publish to IPNS from the browser using ipfs-http-client -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Publish to IPNS from the browser using ipfs-http-client +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -39,7 +39,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -132,8 +132,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-lit/README.md b/examples/browser-lit/README.md index cf146201..ae2fb195 100644 --- a/examples/browser-lit/README.md +++ b/examples/browser-lit/README.md @@ -7,19 +7,19 @@

IPFS Lit App

- Using js-ipfs with web components (lit) -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Using js-ipfs with web components (lit) +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -36,7 +36,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -74,8 +74,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-mfs/README.md b/examples/browser-mfs/README.md index fd07e930..0ccc345e 100644 --- a/examples/browser-mfs/README.md +++ b/examples/browser-mfs/README.md @@ -36,7 +36,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -78,8 +78,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-nextjs/README.md b/examples/browser-nextjs/README.md index dc8cdd61..c1e2238b 100644 --- a/examples/browser-nextjs/README.md +++ b/examples/browser-nextjs/README.md @@ -7,19 +7,19 @@

IPFS Next App

- Using js-ipfs in a `create-next-app` -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature -

+ Using js-ipfs in a `create-next-app` +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature +

## Table of Contents @@ -41,7 +41,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -115,8 +115,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-parceljs/README.md b/examples/browser-parceljs/README.md index d6413604..c7eb575f 100644 --- a/examples/browser-parceljs/README.md +++ b/examples/browser-parceljs/README.md @@ -7,19 +7,19 @@

js-ipfs with parcel.js

- Bundle js-ipfs with ParcelJS! -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Bundle js-ipfs with ParcelJS! +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -36,7 +36,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -79,8 +79,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-readablestream/README.md b/examples/browser-readablestream/README.md index 22585af7..9ef1ab7e 100644 --- a/examples/browser-readablestream/README.md +++ b/examples/browser-readablestream/README.md @@ -7,19 +7,19 @@

js-ipfs video streaming

- Streaming video from IPFS using ReadableStreams -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Streaming video from IPFS using ReadableStreams +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -36,7 +36,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -74,8 +74,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-script-tag/README.md b/examples/browser-script-tag/README.md index 8f6d5f21..5a3160c4 100644 --- a/examples/browser-script-tag/README.md +++ b/examples/browser-script-tag/README.md @@ -7,19 +7,19 @@

js-ipfs CDN

- Use IPFS in the browser using CDN -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Use IPFS in the browser using CDN +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -36,7 +36,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -78,8 +78,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-sharing-node-across-tabs/README.md b/examples/browser-sharing-node-across-tabs/README.md index f1903323..a9da6a4b 100644 --- a/examples/browser-sharing-node-across-tabs/README.md +++ b/examples/browser-sharing-node-across-tabs/README.md @@ -7,19 +7,19 @@

ShareWorker with js-ipfs

- Sharing js-ipfs node across browsing contexts (tabs) using SharedWorker -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Sharing js-ipfs node across browsing contexts (tabs) using SharedWorker +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -36,7 +36,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -78,8 +78,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-video-streaming/README.md b/examples/browser-video-streaming/README.md index 7ba13a27..14f89589 100644 --- a/examples/browser-video-streaming/README.md +++ b/examples/browser-video-streaming/README.md @@ -39,7 +39,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -122,8 +122,9 @@ The most important piece of information to note down is the name you choose for - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-vue/README.md b/examples/browser-vue/README.md index 42735463..143ba595 100644 --- a/examples/browser-vue/README.md +++ b/examples/browser-vue/README.md @@ -7,19 +7,19 @@

IPFS Vue App

- Using js-ipfs in a vue cli project -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Using js-ipfs in a vue cli project +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -42,7 +42,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -114,8 +114,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/browser-webpack/README.md b/examples/browser-webpack/README.md index 38e8d5e3..d7b05146 100644 --- a/examples/browser-webpack/README.md +++ b/examples/browser-webpack/README.md @@ -7,19 +7,19 @@

js-ipfs with webpack

- Bundle js-ipfs with Webpack! -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Bundle js-ipfs with Webpack! +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -36,7 +36,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -76,8 +76,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/circuit-relaying/README.md b/examples/circuit-relaying/README.md index 00f4a130..b7b3e04a 100644 --- a/examples/circuit-relaying/README.md +++ b/examples/circuit-relaying/README.md @@ -7,19 +7,19 @@

IPFS Circuit Relay

- Circuit relay, where it fits in the stack and how to use it.! -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Circuit relay, where it fits in the stack and how to use it.! +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -51,7 +51,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -182,7 +182,7 @@ Here's what we are going to be doing, today: You can use a `go-ipfs` or a `js-ipfs` node as a relay. We'll demonstrate how to set both up in this tutorial and we encourage you to try both out. That said, either js or go should do the trick! -##### Setting up a `go-ipfs` node +#### Setting up a `go-ipfs` node In order to enable the relay functionality in `go-ipfs` we need to edit it's configuration file, located under `~/.ipfs/config`: @@ -216,7 +216,7 @@ We also need to make sure our go node can be dialed from the browser. For that, The config should look similar to the above snippet after we've edited it. -##### Setting up a `js-ipfs` node +#### Setting up a `js-ipfs` node We need to go through similar steps to enable circuit relay in `jsipfs`. However, the config options are slightly different — that should change once this feature is not marked as experimental, but for now we have to deal with two different sets of options. @@ -233,7 +233,7 @@ Just as we did with `go-ipfs`, go ahead and edit `js-ipfs` config file located u Note that we don't have to do anything to enable the `websocket` transport as it is enabled by default in `jsipfs`. -##### Starting the relay node +#### Starting the relay node We can start the relay nodes by either running `ipfs daemon` or `jsipfs daemon`: @@ -260,17 +260,17 @@ In the case of go ipfs, the crucial `/p2p/Qm...` part of the multiaddr might be ```console $ ipfs id { - "ID": "QmY73BLYav2gYc9PCEnjQqbfSGiqFv3aMsRXNyKFGtUoGF", - "PublicKey": "CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC84qPFzqajCfnvaJunqt48S1LIBRthXV60q5QClL+dUfOOU/m7v1ZcpNhvFFUN6tVCDaoT5AxEv0czxZiVx/njl6FVIc6tE1J+HWpc8cbAXNY6QbbyzKl/rjp7V8/QClE0JqgjIk84wnWGTwFhOEt0hnpu2XFt9iHaenSfg3EAa8K9MlbxmbawuxNLJJf7VZXkJrUNl6WOglAVU8Sqc4QaahCLVK5Dzo98zDBq1KDBxMbUgH0LTqzr6i+saxkEHZmBKO+mMVT3LzOUx1DQR4pLAw1qgoJstsIZEaJ2XLh975IiI7OKqWYH7+3NyNK2sldJK/4Zko4rH3irmnkAxLcFAgMBAAE=", - "Addresses": [ - "/ip4/127.0.0.1/tcp/4001/p2p/QmY73BLYav2gYc9PCEnjQqbfSGiqFv3aMsRXNyKFGtUoGF", - "/ip4/192.168.1.132/tcp/4001/p2p/QmY73BLYav2gYc9PCEnjQqbfSGiqFv3aMsRXNyKFGtUoGF", - "/ip6/::1/tcp/4001/p2p/QmY73BLYav2gYc9PCEnjQqbfSGiqFv3aMsRXNyKFGtUoGF", - "/ip4/186.4.18.182/tcp/13285/p2p/QmY73BLYav2gYc9PCEnjQqbfSGiqFv3aMsRXNyKFGtUoGF", - "/ip4/186.4.18.182/tcp/13285/p2p/QmY73BLYav2gYc9PCEnjQqbfSGiqFv3aMsRXNyKFGtUoGF" - ], - "AgentVersion": "go-ipfs/0.4.14-dev/cb5bb7dd8", - "ProtocolVersion": "ipfs/0.1.0" + "ID": "QmY73BLYav2gYc9PCEnjQqbfSGiqFv3aMsRXNyKFGtUoGF", + "PublicKey": "CAASpgIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC84qPFzqajCfnvaJunqt48S1LIBRthXV60q5QClL+dUfOOU/m7v1ZcpNhvFFUN6tVCDaoT5AxEv0czxZiVx/njl6FVIc6tE1J+HWpc8cbAXNY6QbbyzKl/rjp7V8/QClE0JqgjIk84wnWGTwFhOEt0hnpu2XFt9iHaenSfg3EAa8K9MlbxmbawuxNLJJf7VZXkJrUNl6WOglAVU8Sqc4QaahCLVK5Dzo98zDBq1KDBxMbUgH0LTqzr6i+saxkEHZmBKO+mMVT3LzOUx1DQR4pLAw1qgoJstsIZEaJ2XLh975IiI7OKqWYH7+3NyNK2sldJK/4Zko4rH3irmnkAxLcFAgMBAAE=", + "Addresses": [ + "/ip4/127.0.0.1/tcp/4001/p2p/QmY73BLYav2gYc9PCEnjQqbfSGiqFv3aMsRXNyKFGtUoGF", + "/ip4/192.168.1.132/tcp/4001/p2p/QmY73BLYav2gYc9PCEnjQqbfSGiqFv3aMsRXNyKFGtUoGF", + "/ip6/::1/tcp/4001/p2p/QmY73BLYav2gYc9PCEnjQqbfSGiqFv3aMsRXNyKFGtUoGF", + "/ip4/186.4.18.182/tcp/13285/p2p/QmY73BLYav2gYc9PCEnjQqbfSGiqFv3aMsRXNyKFGtUoGF", + "/ip4/186.4.18.182/tcp/13285/p2p/QmY73BLYav2gYc9PCEnjQqbfSGiqFv3aMsRXNyKFGtUoGF" + ], + "AgentVersion": "go-ipfs/0.4.14-dev/cb5bb7dd8", + "ProtocolVersion": "ipfs/0.1.0" } ``` @@ -402,8 +402,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/custom-ipfs-repo/README.md b/examples/custom-ipfs-repo/README.md index cb477202..82cf42ff 100644 --- a/examples/custom-ipfs-repo/README.md +++ b/examples/custom-ipfs-repo/README.md @@ -7,19 +7,19 @@

Custom IPFS repo

- How to customize a IPFS repository -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ How to customize a IPFS repository +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -38,7 +38,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -94,8 +94,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/custom-ipld-formats/README.md b/examples/custom-ipld-formats/README.md index 6d47186d..77fe56cb 100644 --- a/examples/custom-ipld-formats/README.md +++ b/examples/custom-ipld-formats/README.md @@ -7,19 +7,19 @@

Custom IPLD repo

- How to customize a IPLD formats -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ How to customize a IPLD formats +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -37,7 +37,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -80,8 +80,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/custom-libp2p/README.md b/examples/custom-libp2p/README.md index ad1de704..b54ce16a 100644 --- a/examples/custom-libp2p/README.md +++ b/examples/custom-libp2p/README.md @@ -7,19 +7,19 @@

Custom libp2p

- How to customize a libp2p bundle -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ How to customize a libp2p bundle +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -37,7 +37,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -77,8 +77,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/http-client-browser-pubsub/README.md b/examples/http-client-browser-pubsub/README.md index 32990bd6..50d7bc3d 100644 --- a/examples/http-client-browser-pubsub/README.md +++ b/examples/http-client-browser-pubsub/README.md @@ -7,19 +7,19 @@

Pubsub in the browser

- How to use pubsub in the browser! -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ How to use pubsub in the browser! +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -29,12 +29,11 @@ - [Prerequisites](#prerequisites) - [Installation and Running example](#installation-and-running-example) - [Usage](#usage) - - [1. Get started](#1-get-started) - - [2. Start two IPFS nodes](#2-start-two-ipfs-nodes) - - [3. Start the IPFS nodes](#3-start-the-ipfs-nodes) + - [1. Start two IPFS nodes](#1-start-two-ipfs-nodes) + - [2. Start the IPFS nodes](#2-start-the-ipfs-nodes) - [JS IPFS node](#js-ipfs-node) - [GO IPFS node](#go-ipfs-node) - - [4. Open two browsers and connect to each node](#4-open-two-browsers-and-connect-to-each-node) + - [3. Open two browsers and connect to each node](#3-open-two-browsers-and-connect-to-each-node) - [Documentation](#documentation) - [Contributing](#contributing) - [Want to hack on IPFS?](#want-to-hack-on-ipfs) @@ -42,7 +41,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -62,12 +61,19 @@ Make sure you have installed all of the following prerequisites on your developm ### Installation and Running example +With Node.js and git installed, install the project dependencies: + ```console -> npm install -> npm start +$ npm install ``` -Now open your browser at `http://localhost:8888` +Start the example application: + +```sh +npm start +``` + +You should see something similar to the following in your terminal and the web app should now be available if you navigate to http://127.0.0.1:8888 using your browser. ## Usage @@ -93,37 +99,13 @@ This example is a demo web application that allows you to connect to an IPFS nod +-------------------+ +-------------------+ ``` -### 1. Get started - -With Node.js and git installed, clone the repo and install the project dependencies: - -```console -$ git clone https://github.com/ipfs/js-ipfs.git -$ cd js-ipfs/examples/http-client-browser-pubsub -$ npm install -``` - -Start the example application: - -```sh -npm start -``` - -You should see something similar to the following in your terminal and the web app should now be available if you navigate to http://127.0.0.1:8888 using your browser: - -```sh -Starting up http-server, serving ./ -Available on: - http://127.0.0.1:8888 -``` - -### 2. Start two IPFS nodes +### 1. Start two IPFS nodes To demonstrate pubsub we need two nodes running so pubsub messages can be passed between them. -Right now the easiest way to do this is to install and start a `js-ipfs` and `go-ipfs` node. There are other ways to do this, see [this document on running multiple nodes](https://github.com/ipfs/js-ipfs/tree/master/examples/running-multiple-nodes) for details. +Right now the easiest way to do this is to install and start a `js-ipfs` and `go-ipfs` node. There are other ways to do this, see [this document on running multiple nodes](https://github.com/ipfs-examples/js-ipfs-examples/running-multiple-nodes) for details. -### 3. Start the IPFS nodes +### 2. Start the IPFS nodes #### JS IPFS node @@ -146,7 +128,7 @@ ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin '["http://127.0.0 ipfs daemon --enable-pubsub-experiment ``` -### 4. Open two browsers and connect to each node +### 3. Open two browsers and connect to each node Now, open up **two** browser windows. This could be two tabs in the same browser or two completely different browsers, it doesn't matter. Navigate to http://127.0.0.1:8888 in both. @@ -164,8 +146,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/http-client-bundle-webpack/README.md b/examples/http-client-bundle-webpack/README.md index e86cde32..cad1d412 100644 --- a/examples/http-client-bundle-webpack/README.md +++ b/examples/http-client-bundle-webpack/README.md @@ -7,19 +7,19 @@

js-ipfs-http-client with webpack

- Bundle js-ipfs-http-client with Webpack! -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Bundle js-ipfs-http-client with Webpack! +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -37,7 +37,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -94,8 +94,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/http-client-name-api/README.md b/examples/http-client-name-api/README.md index e0293ba9..7df1987f 100644 --- a/examples/http-client-name-api/README.md +++ b/examples/http-client-name-api/README.md @@ -7,19 +7,19 @@

js-ipfs-http-client publish and resolve

- Upload and publish a file to IPFS via the browser using js-ipfs-http-client! -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Upload and publish a file to IPFS via the browser using js-ipfs-http-client! +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -37,7 +37,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -93,8 +93,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/http-client-upload-file/README.md b/examples/http-client-upload-file/README.md index 6b0dabed..5743c438 100644 --- a/examples/http-client-upload-file/README.md +++ b/examples/http-client-upload-file/README.md @@ -7,19 +7,19 @@

js-ipfs-http-client upload file

- Upload file to IPFS via browser using js-ipfs-http-client! -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Upload file to IPFS via browser using js-ipfs-http-client! +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -37,7 +37,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -94,8 +94,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/ipfs-101/README.md b/examples/ipfs-101/README.md index 5f57afea..3c11172f 100644 --- a/examples/ipfs-101/README.md +++ b/examples/ipfs-101/README.md @@ -7,19 +7,19 @@

Tutorial 101

- Demo of "Using go-ipfs as a library" with js-ipfs -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Demo of "Using go-ipfs as a library" with js-ipfs +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -37,7 +37,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -182,8 +182,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/ipfs-client-add-files/README.md b/examples/ipfs-client-add-files/README.md index 9235f120..09e6966d 100644 --- a/examples/ipfs-client-add-files/README.md +++ b/examples/ipfs-client-add-files/README.md @@ -7,19 +7,19 @@

ipfs-client upload file

- Upload file to IPFS via browser using ipfs-client! -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Upload file to IPFS via browser using ipfs-client! +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -37,7 +37,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -90,8 +90,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/run-in-electron/README.md b/examples/run-in-electron/README.md index 6b8249f7..e0e82896 100755 --- a/examples/run-in-electron/README.md +++ b/examples/run-in-electron/README.md @@ -7,19 +7,19 @@

IPFS in Electron

- Simple integration between IPFS and Electron -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Simple integration between IPFS and Electron +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -36,7 +36,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -70,8 +70,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/running-multiple-nodes/README.md b/examples/running-multiple-nodes/README.md index 17fd3eb0..b3778183 100644 --- a/examples/running-multiple-nodes/README.md +++ b/examples/running-multiple-nodes/README.md @@ -7,19 +7,19 @@

Multiple IPFS nodes

- Running multiple JS IPFS nodes -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Running multiple JS IPFS nodes +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -38,7 +38,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -133,8 +133,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/traverse-ipld-graphs/README.md b/examples/traverse-ipld-graphs/README.md index 6d4e624c..d5f7cb43 100644 --- a/examples/traverse-ipld-graphs/README.md +++ b/examples/traverse-ipld-graphs/README.md @@ -7,19 +7,19 @@

Traverse IPLD graphs

- Resolve through IPLD graphs with the dag API -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Resolve through IPLD graphs with the dag API +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -44,7 +44,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -128,8 +128,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/types-use-ipfs-from-ts/README.md b/examples/types-use-ipfs-from-ts/README.md index 02ce9e43..9b4ff99f 100644 --- a/examples/types-use-ipfs-from-ts/README.md +++ b/examples/types-use-ipfs-from-ts/README.md @@ -7,19 +7,19 @@

Using IPFS with Typescript

- Template for using js-ipfs in typescript project -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Template for using js-ipfs in typescript project +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -38,7 +38,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -104,8 +104,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing diff --git a/examples/types-use-ipfs-from-typed-js/README.md b/examples/types-use-ipfs-from-typed-js/README.md index 823bf6df..303e3496 100644 --- a/examples/types-use-ipfs-from-typed-js/README.md +++ b/examples/types-use-ipfs-from-typed-js/README.md @@ -7,19 +7,19 @@

Using IPFS with typed JS

- Template for setting up a project with JSDoc -
-
- -
- Explore the docs - · - View Demo - · - Report Bug - · - Request Feature/Example -

+ Template for setting up a project with JSDoc +
+
+ +
+ Explore the docs + · + View Demo + · + Report Bug + · + Request Feature/Example +

## Table of Contents @@ -39,7 +39,7 @@ ## About The Project - Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs) -- Look into other [examples](https://github.com/ipfs/js-ipfs/tree/master/examples) to learn how to spawn an IPFS node in Node.js and in the Browser +- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser - Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node - Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it - Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs @@ -121,8 +121,9 @@ _For more examples, please refer to the [Documentation](#documentation)_ - [Config](https://docs.ipfs.io/) - [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) -- [Examples](https://github.com/ipfs/js-ipfs/tree/master/examples) +- [Examples](https://github.com/ipfs-examples/js-ipfs-examples) - [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md) +- [Tutorials](https://proto.school) ## Contributing