|
19 | 19 | - [Connection](#connection)
|
20 | 20 | - [API Docs](#api-docs)
|
21 | 21 | - [License](#license)
|
22 |
| -- [Contribute](#contribute) |
| 22 | +- [Contribution](#contribution) |
23 | 23 |
|
24 | 24 | ## Install
|
25 | 25 |
|
@@ -60,10 +60,10 @@ await node.start()
|
60 | 60 | await node.dial('/ip4/127.0.0.1/tcp/9090/ws')
|
61 | 61 | ```
|
62 | 62 |
|
63 |
| -| Name | Type | Description | Default | |
64 |
| -| -------- | -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ----------------------------------------------------------------------- | |
65 |
| -| upgrader | [`Upgrader`](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport#upgrader) | connection upgrader object with `upgradeOutbound` and `upgradeInbound` | **REQUIRED** | |
66 |
| -| filter | `(multiaddrs: Array<Multiaddr>) => Array<Multiaddr>` | override transport addresses filter | **Browser:** DNS+WSS multiaddrs / **Node.js:** DNS+[WS, WSS] multiaddrs | |
| 63 | +| Name | Type | Description | Default | |
| 64 | +| -------- | -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------ | |
| 65 | +| upgrader | [`Upgrader`](https://github.com/libp2p/js-libp2p-interfaces/tree/master/packages/libp2p-interfaces/src/transport#upgrader) | connection upgrader object with `upgradeOutbound` and `upgradeInbound` | **REQUIRED** | |
| 66 | +| filter | `(multiaddrs: Array<Multiaddr>) => Array<Multiaddr>` | override transport addresses filter | **Browser:** DNS+WSS multiaddrs / **Node.js:** DNS+\[WS, WSS] multiaddrs | |
67 | 67 |
|
68 | 68 | You can create your own address filters for this transports, or rely in the filters [provided](./src/filters.js).
|
69 | 69 |
|
@@ -125,6 +125,6 @@ Licensed under either of
|
125 | 125 | - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
|
126 | 126 | - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
|
127 | 127 |
|
128 |
| -## Contribute |
| 128 | +## Contribution |
129 | 129 |
|
130 | 130 | 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