Skip to content

Commit 9a15061

Browse files
achingbrainachingbrain
committed
chore: update package config
1 parent c5a4e3a commit 9a15061

File tree

21 files changed

+79
-84
lines changed

21 files changed

+79
-84
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

‎packages/protocol-autonat/package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
"eslintConfig": {
2929
"extends": "ipfs",
3030
"parserOptions": {
31+
"project": true,
3132
"sourceType": "module"
3233
}
3334
},
@@ -48,9 +49,9 @@
4849
"dependencies": {
4950
"@libp2p/interface": "^0.1.2",
5051
"@libp2p/interface-internal": "^0.1.5",
51-
"@libp2p/peer-id": "^3.0.2" ,
52-
"@libp2p/peer-id-factory": "^3.0.4" ,
5352
"@libp2p/logger": "^3.0.2",
53+
"@libp2p/peer-id": "^3.0.2",
54+
"@libp2p/peer-id-factory": "^3.0.4",
5455
"@multiformats/multiaddr": "^12.1.5",
5556
"it-first": "^3.0.1",
5657
"it-length-prefixed": "^9.0.1",

‎packages/protocol-autonat/tsconfig.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@
1515
"path": "../interface-internal"
1616
},
1717
{
18-
"path": "../peer-id"
18+
"path": "../logger"
1919
},
2020
{
21-
"path": "../peer-id-factory"
21+
"path": "../peer-id"
2222
},
2323
{
24-
"path": "../logger"
24+
"path": "../peer-id-factory"
2525
}
2626
]
2727
}

‎packages/protocol-perf/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,20 @@ await libp2p1.stop()
5757
await libp2p2.stop()
5858
```
5959

60+
# Install
61+
62+
```console
63+
$ npm i @libp2p/perf
64+
```
65+
66+
## Browser `<script>` tag
67+
68+
Loading this module through a script tag will make it's exports available as `Libp2pPerf` in the global namespace.
69+
70+
```html
71+
<script src="https://unpkg.com/@libp2p/perf/dist/index.min.js"></script>
72+
```
73+
6074
# API Docs
6175

6276
- <https://libp2p.github.io/js-libp2p/modules/_libp2p_perf.html>

‎packages/protocol-perf/tsconfig.json

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@
88
"test"
99
],
1010
"references": [
11-
{
12-
"path": "../crypto"
13-
},
1411
{
1512
"path": "../interface"
1613
},
@@ -20,17 +17,8 @@
2017
{
2118
"path": "../interface-internal"
2219
},
23-
{
24-
"path": "../libp2p"
25-
},
2620
{
2721
"path": "../logger"
28-
},
29-
{
30-
"path": "../peer-id-factory"
31-
},
32-
{
33-
"path": "../transport-tcp"
3422
}
3523
]
3624
}

‎packages/stream-multiplexer-mplex/README.md

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

22-
## API Docs
22+
> JavaScript implementation of <https://github.com/libp2p/mplex>
23+
24+
# API Docs
2325

2426
- <https://libp2p.github.io/js-libp2p/modules/_libp2p_mplex.html>
2527

26-
## License
28+
# License
2729

2830
Licensed under either of
2931

3032
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
3133
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
3234

33-
## Contribution
35+
# Contribution
3436

3537
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/transport-webtransport/README.md

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

43-
For more information see [libp2p/js-libp2p/doc/CONFIGURATION.md#customizing-transports](https://github.com/libp2p/js-libp2p/blob/master/doc/CONFIGURATION.md#customizing-transports).
44-
4543
# API Docs
4644

4745
- <https://libp2p.github.io/js-libp2p/modules/_libp2p_webtransport.html>
@@ -56,5 +54,3 @@ Licensed under either of
5654
# Contribution
5755

5856
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.
59-
60-
See the [Contributing](./CONTRIBUTING.md) doc for details on developing changes to this repo.

‎packages/transport-webtransport/package.json

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,6 @@
1616
],
1717
"type": "module",
1818
"types": "./dist/src/index.d.ts",
19-
"typesVersions": {
20-
"*": {
21-
"*": [
22-
"*",
23-
"dist/*",
24-
"dist/src/*",
25-
"dist/src/*/index"
26-
],
27-
"src/*": [
28-
"*",
29-
"dist/*",
30-
"dist/src/*",
31-
"dist/src/*/index"
32-
]
33-
}
34-
},
3519
"files": [
3620
"src",
3721
"dist",

‎packages/transport-webtransport/tsconfig.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
},
2020
{
2121
"path": "../peer-id"
22+
},
23+
{
24+
"path": "../peer-id-factory"
2225
}
2326
]
2427
}

‎packages/upnp-nat/README.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,17 @@
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+
> UPnP NAT hole punching
7+
68
# Install
79

810
```console
9-
$ npm i @libp2p/peer-id
10-
```
11-
12-
## Browser `<script>` tag
13-
14-
Loading this module through a script tag will make it's exports available as `Libp2pPeerId` in the global namespace.
15-
16-
```html
17-
<script src="https://unpkg.com/@libp2p/peer-id/dist/index.min.js"></script>
11+
$ npm i @libp2p/upnp-nat
1812
```
1913

2014
# API Docs
2115

22-
- <https://libp2p.github.io/js-libp2p/modules/_libp2p_peer_id.html>
16+
- <https://libp2p.github.io/js-libp2p/modules/_libp2p_upnp_nat.html>
2317

2418
# License
2519

‎packages/upnp-nat/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"version": "0.0.0",
44
"description": "UPnP NAT hole punching",
55
"license": "Apache-2.0 OR MIT",
6-
"homepage": "https://github.com/libp2p/js-libp2p/tree/master/packages/peer-id#readme",
6+
"homepage": "https://github.com/libp2p/js-libp2p/tree/master/packages/upnp-nat#readme",
77
"repository": {
88
"type": "git",
99
"url": "git+https://github.com/libp2p/js-libp2p.git"

‎packages/upnp-nat/tsconfig.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,18 @@
1010
"references": [
1111
{
1212
"path": "../interface"
13+
},
14+
{
15+
"path": "../interface-internal"
16+
},
17+
{
18+
"path": "../logger"
19+
},
20+
{
21+
"path": "../peer-id-factory"
22+
},
23+
{
24+
"path": "../utils"
1325
}
1426
]
1527
}

0 commit comments

Comments
 (0)