From f20d10f42357f7a092d6672809b01485e85aba9f Mon Sep 17 00:00:00 2001 From: kvutien Date: Mon, 5 Jul 2021 14:28:04 +0200 Subject: [PATCH 1/3] minor typos in README --- examples/browser-create-react-app/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/examples/browser-create-react-app/README.md b/examples/browser-create-react-app/README.md index 32effb8912..c85cf1bf4b 100755 --- a/examples/browser-create-react-app/README.md +++ b/examples/browser-create-react-app/README.md @@ -1,15 +1,15 @@ ## IPFS React app -A minimal demonstration of how to use js-ipfs in a `create-react-app` generated app. +This is a minimal demonstration of how to use `js-ipfs` in a `create-react-app` generated app. -It boots up a js-ipfs instance (an IPFS node) via a custom React hook in `./src/hooks/use-ipfs-factory.js`, which is called from `./src/App.js`. Once the IPFS node is set up, `App.js` displays its ident and its version number. +It boots up a `js-ipfs` instance (an IPFS node) via a custom React hook in `./src/hooks/use-ipfs-factory.js`, which is called from `./src/App.js`. Once the IPFS node is set up, `./src/App.js` displays the ident of this node and the version number of `js-ipfs` used to spawn it. -> _Remember that a Peer ID of an IPFS node is [the multihash of the public key of this node](https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md#peer-ids), and the public-private key pair of a node is generated by typing `ipfs init`._ +> _Side note: what we call ident here, or "id", is the Peer ID of the IPFS node and is [the multihash of the public key of this node](https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md#peer-ids). The public-private key pair of a node is generated by typing `ipfs init`._ ![Screen shot of the js ipfs node id info](./images/screenshot.png) -**Note**: this example is useful to learn how to spawn IPFS from a web page. It is also possible to [spawn an IPFS daemon from the command line](https://docs.ipfs.io/install/command-line/) with `ipfs daemon`. While self-hosting is advised, one can also delegate IPFS operations to a third-party like Infura. See tutorials [here](https://blog.infura.io/part-2-getting-started-with-ipfs-on-infura/) and [here](https://blog.infura.io/part-2-getting-started-with-ipfs-on-infura/). +**Note**: this example demo is useful to learn how to spawn IPFS from a web page. It is also possible to [spawn an IPFS daemon from the command line](https://docs.ipfs.io/install/command-line/) with `ipfs daemon`. While self-hosting is advised, one can also delegate IPFS operations to a third-party like Infura. See tutorials [here](https://blog.infura.io/part-2-getting-started-with-ipfs-on-infura/) and [here](https://blog.infura.io/part-2-getting-started-with-ipfs-on-infura/). ## To start @@ -28,9 +28,9 @@ All React applications store their main logic in `App.js`: * `useIpfs.js` does the actual calls to IPFS to retrieve the property specified in argument (here the retrieved property is `id`, requested from `App.js`) ## Annexes -### Console message `[HMR] Waiting for update signal from WDS...` +### You may be puzzled by a console message `[HMR] Waiting for update signal from WDS...` -This message comes from the hot reload capability of webpack, that can update the web app every time you save your development code. To remove it, see here: https://stackoverflow.com/questions/59695102/reactjs-console-error-hmr-waiting-for-update-signal-from-wds +This message comes from the hot reload capability of `webpack`, that can update the web app every time you save your development code. To remove it, see here: https://stackoverflow.com/questions/59695102/reactjs-console-error-hmr-waiting-for-update-signal-from-wds ### Available Scripts from create-react-app @@ -64,5 +64,5 @@ But with modern hosting services like Heroku, Netlity or Fleek, you can skip the You can learn more on IPFS API in the [IPFS documentation](https://docs.ipfs.io/) and [IPFS npm documentation](https://www.npmjs.com/package/ipfs-http-client). -Details how to use the File System abstraction of IPFS (add, cat, egt, ls etc.) are [here](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) +Details how to use the File System abstraction of IPFS (add, cat, get, ls etc.) are [here](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) From c72ebb16ed282c2ff06e690b93f930e5589ba110 Mon Sep 17 00:00:00 2001 From: kvutien Date: Mon, 5 Jul 2021 14:32:14 +0200 Subject: [PATCH 2/3] minor typos in README --- examples/browser-create-react-app/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/browser-create-react-app/README.md b/examples/browser-create-react-app/README.md index c85cf1bf4b..13ae0d2376 100755 --- a/examples/browser-create-react-app/README.md +++ b/examples/browser-create-react-app/README.md @@ -23,7 +23,7 @@ $ npm start ``` ## Call structure in `App.js` All React applications store their main logic in `App.js`: -* `App.js` renders the cosmetics of the demo and call `useIpfs` to retrieve the `id` of the node +* `App.js` renders the cosmetics of the demo and calls `useIpfs` to retrieve the `id` of the node * `useIpfsFactory.js` initialises and closes the IPFS local node * `useIpfs.js` does the actual calls to IPFS to retrieve the property specified in argument (here the retrieved property is `id`, requested from `App.js`) From 54d1ed33f5974c4e7616138560bae559ee99cda4 Mon Sep 17 00:00:00 2001 From: Alex Potsides Date: Tue, 27 Jul 2021 11:44:13 +0100 Subject: [PATCH 3/3] doc: small edits --- examples/browser-create-react-app/README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/examples/browser-create-react-app/README.md b/examples/browser-create-react-app/README.md index 13ae0d2376..4e7260eaea 100755 --- a/examples/browser-create-react-app/README.md +++ b/examples/browser-create-react-app/README.md @@ -2,14 +2,14 @@ This is a minimal demonstration of how to use `js-ipfs` in a `create-react-app` generated app. -It boots up a `js-ipfs` instance (an IPFS node) via a custom React hook in `./src/hooks/use-ipfs-factory.js`, which is called from `./src/App.js`. Once the IPFS node is set up, `./src/App.js` displays the ident of this node and the version number of `js-ipfs` used to spawn it. +It boots up a `js-ipfs` instance (an IPFS node) via a custom React hook in `./src/hooks/use-ipfs-factory.js`, which is called from `./src/App.js`. Once the IPFS node is set up, `./src/App.js` displays the [PeerId](https://docs.libp2p.io/concepts/peer-id/) of this node and the version number of `js-ipfs` used to spawn it. -> _Side note: what we call ident here, or "id", is the Peer ID of the IPFS node and is [the multihash of the public key of this node](https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md#peer-ids). The public-private key pair of a node is generated by typing `ipfs init`._ +> _Side note: The PeerId of the IPFS node is [the multihash of the public key of this node](https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md#peer-ids). The public-private key pair of a node is generated by typing `ipfs init`._ ![Screen shot of the js ipfs node id info](./images/screenshot.png) -**Note**: this example demo is useful to learn how to spawn IPFS from a web page. It is also possible to [spawn an IPFS daemon from the command line](https://docs.ipfs.io/install/command-line/) with `ipfs daemon`. While self-hosting is advised, one can also delegate IPFS operations to a third-party like Infura. See tutorials [here](https://blog.infura.io/part-2-getting-started-with-ipfs-on-infura/) and [here](https://blog.infura.io/part-2-getting-started-with-ipfs-on-infura/). +**Note**: this example is useful to learn how to spawn IPFS from a web page. It is also possible to [spawn an IPFS daemon from the command line](https://docs.ipfs.io/install/command-line/) with `ipfs daemon`. While self-hosting is advised, one can also delegate IPFS operations to a third-party like Infura. See tutorials [here](https://blog.infura.io/part-2-getting-started-with-ipfs-on-infura/) and [here](https://blog.infura.io/part-2-getting-started-with-ipfs-on-infura/). ## To start @@ -65,4 +65,3 @@ But with modern hosting services like Heroku, Netlity or Fleek, you can skip the You can learn more on IPFS API in the [IPFS documentation](https://docs.ipfs.io/) and [IPFS npm documentation](https://www.npmjs.com/package/ipfs-http-client). Details how to use the File System abstraction of IPFS (add, cat, get, ls etc.) are [here](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/FILES.md) -