You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+14-11
Original file line number
Diff line number
Diff line change
@@ -116,12 +116,15 @@ The CLI is available by using the command `jsipfs` in your terminal. This is ali
116
116
Learn how to bundle with browserify and webpack in the [`examples`](https://github.com/ipfs/js-ipfs/tree/master/examples) folder.
117
117
118
118
119
-
You can also load it using a `<script>` using the [unpkg](https://unpkg.com) CDN. Inserting one of the following lines will make a `Ipfs` object available in the global namespace.
120
-
119
+
You can also load it using a `<script>` from the [unpkg](https://unpkg.com) CDN:
121
120
```html
122
-
<scriptsrc="https://unpkg.com/ipfs/dist/index.min.js"></script> <!-- loading the minified version -->
123
-
<scriptsrc="https://unpkg.com/ipfs/dist/index.js"></script> <!-- loading the human-readable (not minified) version -->
Inserting one of the above lines will make an `Ipfs` object available in the global namespace.
125
128
126
129
## Usage
127
130
@@ -487,7 +490,7 @@ Then, update your IPFS Daemon config to include the multiaddr for this new trans
487
490
488
491
### Lint
489
492
490
-
*Conforming to linting rules is a prerequisite to commit to js-ipfs.*
493
+
**Conforming to linting rules is a prerequisite to commit to js-ipfs.**
491
494
492
495
```sh
493
496
> npm run lint
@@ -522,11 +525,11 @@ src # Main source code folder
522
525
### Monitoring
523
526
524
527
The HTTP API exposed with js-ipfs can also be used for exposing metrics about
525
-
the running js-ipfs node and other nodejs metrics.
528
+
the running js-ipfs node and other Node.js metrics.
526
529
527
530
To enable it, you need to set the environment variable `IPFS_MONITORING` (any value)
528
531
529
-
Once environment variable is set and the js-ipfs daemon is running, you can get
532
+
Once the environment variable is set and the js-ipfs daemon is running, you can get
530
533
the metrics (in prometheus format) by making a GET request to the following endpoint:
531
534
532
535
```
@@ -541,17 +544,17 @@ What does this image explain?
541
544
542
545
- IPFS uses `ipfs-repo` which picks `fs` or `indexeddb` as its storage drivers, depending if it is running in Node.js or in the Browser.
543
546
- The exchange protocol, `bitswap`, uses the Block Service which in turn uses the Repo, offering a get and put of blocks to the IPFS implementation.
544
-
- The DAG api (previously Object) comes from the IPLD Resolver, it can support several IPLD Formats (i.e: dag-pb, dag-cbor, etc).
547
+
- The DAG API (previously Object) comes from the IPLD Resolver, it can support several IPLD Formats (i.e: dag-pb, dag-cbor, etc).
545
548
- The Files API uses `ipfs-unixfs-engine` to import and export files to and from IPFS.
546
-
- Swarm, the component that offers a network API, uses libp2p to dial and listen for connections, use the DHT, discovery mechanisms and more. libp2p-ipfs-nodejs is used in case of running in Node.js and libp2p-ipfs-browser is used in the case of the Browser.
549
+
- Swarm, the component that offers a network API, uses libp2p to dial and listen for connections, to use the DHT, for discovery mechanisms, and more. libp2p-ipfs-nodejs is used when running in Node.js and libp2p-ipfs-browser is used when running in the browser.
547
550
548
551
## Contribute
549
552
550
553
IPFS implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:
551
554
552
555
* Go through the modules below and **check out existing issues**. This would be especially useful for modules in active development. Some knowledge of IPFS may be required, as well as the infrastructure behind it - for instance, you may need to read up on p2p and more complex operations like muxing to be able to help technically.
553
-
***Perform code reviews**. More eyes will help a) speed the project alongb) ensure quality and c) reduce possible future bugs.
554
-
* Take a look at go-ipfs and some of the planning repositories or issues: for instance, the libp2p spec[here](https://github.com/ipfs/specs/pull/19). Contributions here that would be most helpful are **top-level comments** about how it should look based on our understanding. Again, the more eyes the better.
556
+
***Perform code reviews**. More eyes will help (a) speed the project along, (b) ensure quality, and (c) reduce possible future bugs.
557
+
* Take a look at go-ipfs and some of the planning repositories or issues: for instance, the [libp2p spec](https://github.com/ipfs/specs/pull/19). Contributions here that would be most helpful are **top-level comments** about how it should look based on our understanding. Again, the more eyes the better.
555
558
***Add tests**. There can never be enough tests.
556
559
***Contribute to the [FAQ repository](https://github.com/ipfs/faq/issues)** with any questions you have about IPFS or any of the relevant technology. A good example would be asking, 'What is a merkledag tree?'. If you don't know a term, odds are, someone else doesn't either. Eventually, we should have a good understanding of where we need to improve communications and teaching together to make IPFS and IPN better.
0 commit comments