Skip to content

Commit f48b415

Browse files
committed
chore: update package config
1 parent 87985ce commit f48b415

File tree

21 files changed

+77
-82
lines changed

21 files changed

+77
-82
lines changed

interop/README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@
77

88
> Multidimensional interop tests
99
10+
# Install
11+
12+
```console
13+
$ npm i @libp2p/multidim-interop
14+
```
15+
1016
## Table of contents <!-- omit in toc -->
1117

1218
- [Usage](#usage)
@@ -51,14 +57,14 @@ $ docker build . -f ./interop/BrowserDockerfile -t js-libp2p-browsers
5157
$ git clone https://github.com/libp2p/test-plans.git
5258
```
5359
2. (Optional) If you are running an M1 Mac you may need to override the build platform.
54-
- Edit `/multidim-interop/dockerBuildWrapper.sh`
55-
- Add `--platform linux/arm64/v8` to the `docker buildx build` command
56-
```
57-
docker buildx build \
58-
--platform linux/arm64/v8 \ <-- add this line
59-
--load \
60-
-t $IMAGE_NAME $CACHING_OPTIONS "$@"
61-
```
60+
- Edit `/multidim-interop/dockerBuildWrapper.sh`
61+
- Add `--platform linux/arm64/v8` to the `docker buildx build` command
62+
```
63+
docker buildx build \
64+
--platform linux/arm64/v8 \ <-- add this line
65+
--load \
66+
-t $IMAGE_NAME $CACHING_OPTIONS "$@"
67+
```
6268
3. (Optional) Enable some sort of debug output
6369
- nim-libp2p
6470
- edit `/multidim-interop/impl/nim/$VERSION/Dockerfile`
@@ -106,13 +112,13 @@ $ docker run -e transport=webtransport -e muxer=yamux -e security=noise -e is_di
106112
$ docker run -e transport=tcp -e muxer=yamux -e security=noise -e is_dialer=false -e redis_addr=redis:6379 --link redis:redis go-v0.29
107113
```
108114

109-
## License
115+
# License
110116

111117
Licensed under either of
112118

113119
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
114120
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
115121

116-
## Contribution
122+
# Contribution
117123

118124
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.

packages/crypto/README.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,6 @@ Loading this module through a script tag will make it's exports available as `Li
1919
<script src="https://unpkg.com/@libp2p/crypto/dist/index.min.js"></script>
2020
```
2121

22-
# Contribute
23-
24-
Feel free to join in. All welcome. Open an [issue](https://github.com/libp2p/js-libp2p-crypto/issues)!
25-
26-
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
27-
28-
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
29-
3022
# API Docs
3123

3224
- <https://libp2p.github.io/js-libp2p/modules/_libp2p_crypto.html>

packages/kad-dht/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,6 @@ Loading this module through a script tag will make it's exports available as `Li
1919
<script src="https://unpkg.com/@libp2p/kad-dht/dist/index.min.js"></script>
2020
```
2121

22-
```sh
23-
> npm i @libp2p/kad-dht
24-
```
25-
2622
# API Docs
2723

2824
- <https://libp2p.github.io/js-libp2p/modules/_libp2p_kad_dht.html>

packages/keychain/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,17 +70,17 @@ Loading this module through a script tag will make it's exports available as `Li
7070
<script src="https://unpkg.com/@libp2p/keychain/dist/index.min.js"></script>
7171
```
7272

73-
## API Docs
73+
# API Docs
7474

7575
- <https://libp2p.github.io/js-libp2p/modules/_libp2p_keychain.html>
7676

77-
## License
77+
# License
7878

7979
Licensed under either of
8080

8181
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
8282
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
8383

84-
## Contribution
84+
# Contribution
8585

8686
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.

packages/libp2p/tsconfig.json

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55
},
66
"include": [
77
"src",
8-
"test"
9-
, "../upnp-nat/test/upnp-nat" ],
8+
"test",
9+
"../upnp-nat/test/upnp-nat"
10+
],
1011
"references": [
1112
{
1213
"path": "../crypto"
@@ -23,9 +24,6 @@
2324
{
2425
"path": "../kad-dht"
2526
},
26-
{
27-
"path": "../keychain"
28-
},
2927
{
3028
"path": "../logger"
3129
},

packages/libp2p/typedoc.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
"entryPoints": [
33
"./src/index.ts",
44
"./src/circuit-relay/index.ts",
5+
"./src/dcutr/index.ts",
56
"./src/fetch/index.ts",
67
"./src/identify/index.ts",
78
"./src/insecure/index.ts",
8-
"./src/ping/index.ts",
9-
"./src/upnp-nat/index.ts"
9+
"./src/ping/index.ts"
1010
]
1111
}

packages/peer-discovery-mdns/tsconfig.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@
2525
},
2626
{
2727
"path": "../peer-id-factory"
28+
},
29+
{
30+
"path": "../utils"
2831
}
2932
]
3033
}

packages/peer-id/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p)
44
[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p/main.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p/actions/workflows/main.yml?query=branch%3Amaster)
55

6+
> Implementation of @libp2p/interface-peer-id
7+
68
# Install
79

810
```console

packages/pnet/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ Loading this module through a script tag will make it's exports available as `Li
7777
<script src="https://unpkg.com/@libp2p/pnet/dist/index.min.js"></script>
7878
```
7979

80+
# API Docs
81+
82+
- <https://libp2p.github.io/js-libp2p/modules/_libp2p_pnet.html>
83+
8084
# License
8185

8286
Licensed under either of

packages/protocol-autonat/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ $ npm i @libp2p/autonat
4545
Loading this module through a script tag will make it's exports available as `Libp2pAutonat` in the global namespace.
4646

4747
```html
48-
<script src="https://unpkg.com/@libp2p/perf/dist/index.min.js"></script>
48+
<script src="https://unpkg.com/@libp2p/autonat/dist/index.min.js"></script>
4949
```
5050

5151
# API Docs

0 commit comments

Comments
 (0)