|
1 |
| -# js-libp2p-bootstrap |
| 1 | +# @libp2p/bootstrap <!-- omit in toc --> |
2 | 2 |
|
3 |
| -[](http://protocol.ai) |
4 |
| -[](http://libp2p.io/) |
5 |
| -[](http://webchat.freenode.net/?channels=%23libp2p) |
6 |
| -[](https://discuss.libp2p.io) |
7 |
| -[](https://codecov.io/gh/libp2p/js-libp2p-bootstrap) |
8 |
| -[](https://github.com/libp2p/js-libp2p-bootstrap/actions/workflows/js-test-and-release.yml) |
9 |
| -[](https://github.com/feross/standard) |
10 |
| - |
| 3 | +[](http://libp2p.io/) |
| 4 | +[](http://webchat.freenode.net/?channels=%23libp2p) |
| 5 | +[](https://discuss.libp2p.io) |
| 6 | +[](https://codecov.io/gh/libp2p/js-libp2p-bootstrap) |
| 7 | +[](https://github.com/libp2p/js-libp2p-bootstrap/actions/workflows/js-test-and-release.yml) |
11 | 8 |
|
12 |
| -> JavaScript libp2p Implementation of the railing process of a Node through a bootstrap peer list |
| 9 | +> Node.js IPFS Implementation of the railing process of a Node through a bootstrap peer list |
| 10 | +
|
| 11 | +## Table of contents <!-- omit in toc --> |
| 12 | + |
| 13 | +- [Install](#install) |
| 14 | +- [Usage](#usage) |
| 15 | +- [Contribute](#contribute) |
| 16 | +- [License](#license) |
| 17 | +- [Contribution](#contribution) |
| 18 | + |
| 19 | +## Install |
| 20 | + |
| 21 | +```console |
| 22 | +$ npm i @libp2p/bootstrap |
| 23 | +``` |
13 | 24 |
|
14 | 25 | ## Usage
|
15 | 26 |
|
@@ -60,16 +71,16 @@ start()
|
60 | 71 |
|
61 | 72 | The libp2p implementation in JavaScript is a work in progress. As such, there are a few things you can do right now to help out:
|
62 | 73 |
|
63 |
| - - Go through the modules and **check out existing issues**. This is especially useful for modules in active development. Some knowledge of IPFS/libp2p 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. |
64 |
| - - **Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs. |
| 74 | +- Go through the modules and **check out existing issues**. This is especially useful for modules in active development. Some knowledge of IPFS/libp2p 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. |
| 75 | +- **Perform code reviews**. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs. |
65 | 76 |
|
66 | 77 | ## License
|
67 | 78 |
|
68 | 79 | Licensed under either of
|
69 | 80 |
|
70 |
| - * Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0) |
71 |
| - * MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT) |
| 81 | +- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>) |
| 82 | +- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>) |
72 | 83 |
|
73 |
| -### Contribution |
| 84 | +## Contribution |
74 | 85 |
|
75 | 86 | Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
|
0 commit comments