chore: update readmes

Author: achingbrain

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

@@ -4,4 +4,17 @@ If you have a number of files that you'd like to add to IPFS and end up with a h
 
 But what if you don't know how many there will be in advance?  You can add multiple files to a directory in IPFS over time by using [`ipfs.addReadableStream`](https://github.com/ipfs/js-ipfs/blob/master/packages/interface-ipfs-core/SPEC/FILES.md#addreadablestream).
 
-See `index.js` for a working example and open `index.html` in your browser to see it run.
+## Before you start
+
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Running the example
+
+See [`index.js`](./index.js) for a working example and open [`index.html`](./index.html) in your browser to see it run.

examples/browser-browserify/README.md

@@ -2,9 +2,20 @@
 
 In this example, you will find a boilerplate you can use to guide yourself into bundling js-ipfs with [browserify](http://browserify.org/), so that you can use it in your own web app!
 
-## Run this example
+## Before you start
 
-First install dependencies in the project root directory with `npm install`. Then in this directory run:
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Running the example
+
+In this directory run:
 
 ```bash
 > npm start

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

@@ -8,6 +8,17 @@ It boots up a js-ipfs instance via a custom React hook in `./src/hooks/use-ipfs-
 
 This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). **v2.1.3**
 
+## Before you start
+
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
 ## Available Scripts
 
 In the project directory, you can run:

examples/browser-mfs/README.md

@@ -8,9 +8,18 @@ This demo allows you to upload files from your computer and use them to explore
 
 ![screenshot](screenshot_2.png)
 
-## Running the demo
+## Before you start
 
-Fork and clone this repo.
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Running the example
 
 Navigate into this directory:
 

examples/browser-parceljs/README.md

@@ -6,6 +6,17 @@ that you can follow it for creating Parcel.js bundled js-ipfs DApps.
 
 ## Before you start
 
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Running the example
+
 1. Start your IPFS daemon of choice e.g. `ipfs daemon` (optional if you do not
 want to serve the example over IPFS)
 1. Open a new terminal

examples/browser-readablestream/README.md

@@ -4,7 +4,18 @@ We can use the execllent [`videostream`](https://www.npmjs.com/package/videostre
 
 Take a look at [`index.js`](./index.js) to see a working example.
 
-## Running the demo
+## Before you start
+
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Running the example
 
 In this directory:
 

examples/browser-script-tag/README.md

@@ -8,4 +8,17 @@ You can use IPFS in your in-browser JavaScript code with just a `<script>` tag.
 
 This exposes a global `Ipfs`; you can get a node by making a `new Ipfs()`.
 
+## Before you start
+
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Running the example
+
 See `index.html` for a working example.

examples/browser-video-streaming/README.md

@@ -28,22 +28,33 @@ In order for any of the above to be useful, we also need to have a way to actual
 
 For example, say we have a directory containing a video file `BigBuckBunny_320x180.mp4`. We can then create a sub directory and generate the HLS data there, and finally add it to IPFS:
 
-```bash
-> mkdir hls-bunny
-> cd hls-bunny
-> ffmpeg -i ../BigBuckBunny_320x180.mp4 -profile:v baseline -level 3.0 -start_number 0 -hls_time 5 -hls_list_size 0 -f hls master.m3u8
-> ipfs add -Qr .
+```console
+$ mkdir hls-bunny
+$ cd hls-bunny
+$ ffmpeg -i ../BigBuckBunny_320x180.mp4 -profile:v baseline -level 3.0 -start_number 0 -hls_time 5 -hls_list_size 0 -f hls master.m3u8
+$ 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.
 
-## Putting it all together
+## Before you start
+
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Running the example
 
 *Note:* If you try to run the example straight from disk, some browsers (e.g Chrome) might, for security reasons, prevent some resources from loading correctly. To get around this, simply cd into the directory of this example and use http-server from npm:
 
-```bash
-> npm install -g http-server
-> http-server
+```console
+$ npm install -g http-server
+$ http-server
 ```
 
 You should then be able to stream Big Buck Bunny by pointing your browser at http://localhost:8080.

examples/browser-vue/README.md

@@ -6,28 +6,39 @@ A minimal demonstration of how to use `js-ipfs` with `Vue`.
 
 This project was bootstrapped with [Vue CLI](https://cli.vuejs.org/).
 
+## Before you start
+
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
 ### Compiles and hot-reloads for development
 
-```bash
-npm run serve
+```console
+$ npm run serve
 ```
 
 ### Compiles and minifies for production
 
-```bash
-npm run build
+```console
+$ npm run build
 ```
 
 ### Run your tests
 
-```bash
-npm run test
+```console
+$ npm run test
 ```
 
 ### Lints and fixes files
 
-```bash
-npm run lint
+```console
+$ npm run lint
 ```
 
 ### Customize configuration

examples/browser-webpack/README.md

@@ -2,12 +2,23 @@
 
 > In this example, you will find a boilerplate you can use to guide yourself into bundling js-ipfs with webpack, so that you can use it in your own web app!
 
-## Run this example
+## Before you start
+
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Running the example
 
 Once the daemon is on, run the following command within this folder:
 
 ```bash
-> npm start
+$ npm start
 ```
 
 Now open your browser at `http://localhost:3000`

examples/circuit-relaying/README.md

@@ -101,6 +101,19 @@ Here's what we are going to be doing, today:
 
 Let's go.
 
+## Before you start
+
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Running the example
+
 ### 1. Set up
 
 You'll need to have an implementation of IPFS running on your machine. Currently, this means either go-ipfs or js-ipfs.

examples/custom-ipfs-repo/README.md

@@ -7,7 +7,18 @@ This example shows you how to customize your repository, including where your da
 
 You can find full details on customization in the [IPFS Repo Docs](https://github.com/ipfs/js-ipfs-repo#setup).
 
-## Run this example
+## Before you start
+
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Running the example
 
 ```
 > npm start

examples/custom-libp2p/README.md

@@ -2,7 +2,18 @@
 
 This example shows you how to make full use of the ipfs configuration to create a libp2p bundle function. As IPFS applications become more complex, their needs for a custom libp2p bundle also grow. Instead of fighting with configuration options, you can use your own libp2p bundle function to get exactly what you need.
 
-## Run this example
+## Before you start
+
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Running the example
 
 Running this example should result in metrics being logged out to the console every few seconds.
 

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

@@ -42,6 +42,19 @@ Here's what we are going to be doing:
 
 Just follow the instructions below and it will be up and running in no time!
 
+## Before you start
+
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Running the example
+
 ### 1. Install `go-ipfs` or `js-ipfs`
 
 If you already have `go-ipfs` or `js-ipfs` installed in your machine, you can skip this step. Otherwise, read on.

examples/explore-ethereum-blockchain/README.md

@@ -2,7 +2,18 @@
 
 > This is a pre-example to a full Ethereum to IPFS bridge. It shows how to resolve Ethereum hashes through the IPFS DAG get API.
 
-## Set up
+## Before you start
+
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Running the example
 
 Make sure to have the latest js-ipfs installed by doing
 

examples/ipfs-101/README.md

@@ -6,6 +6,19 @@ In this tutorial, we go through spawning an IPFS node, adding a file and cat'ing
 
 You can find a complete version of this tutorial in [1.js](./1.js). For this tutorial, you need to install `ipfs` using `npm install ipfs`.
 
+## Before you start
+
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Running the example
+
 Creating an IPFS instance can be done in one line, after requiring the module, you simply have to:
 
 ```js

examples/run-in-electron/README.md

@@ -2,6 +2,19 @@
 
 > This example is heavily inspired by [electron-quick-start](https://github.com/electron/electron-quick-start).
 
+## Before you start
+
+First clone this repo, install dependencies in the project root and build the project.
+
+```console
+$ git clone https://github.com/ipfs/js-ipfs.git
+$ cd js-ipfs
+$ npm install
+$ npm run build
+```
+
+## Running the example
+
 To try it by yourself, do:
 
 ```