From fd1f8343db030d74cd08bca6a0cffda93532765f Mon Sep 17 00:00:00 2001 From: Alex Potsides Date: Tue, 23 Apr 2024 11:27:02 +0100 Subject: [PATCH] docs: fix broken links in docs site (#2497) Closes #2423 --- CONTRIBUTING.md | 6 +- README.md | 76 +++++++++---------- doc/CONFIGURATION.md | 8 +- doc/GETTING_STARTED.md | 18 ++--- doc/METRICS.md | 2 +- doc/PEER_DISCOVERY.md | 6 +- doc/production/README.md | 2 +- interop/README.md | 4 +- .../connection-encrypter-plaintext/README.md | 4 +- packages/connection-encrypter-tls/README.md | 4 +- packages/crypto/README.md | 4 +- packages/interface-compliance-tests/README.md | 4 +- packages/interface-internal/README.md | 4 +- packages/interface/README.md | 4 +- packages/kad-dht/README.md | 4 +- packages/keychain/README.md | 6 +- packages/keychain/src/index.ts | 2 +- packages/libp2p/README.md | 10 +-- packages/libp2p/src/index.ts | 2 +- packages/logger/README.md | 4 +- packages/metrics-prometheus/README.md | 4 +- packages/multistream-select/README.md | 4 +- packages/peer-collections/README.md | 4 +- packages/peer-discovery-bootstrap/README.md | 4 +- packages/peer-discovery-mdns/README.md | 4 +- packages/peer-id-factory/README.md | 4 +- packages/peer-id/README.md | 4 +- packages/peer-record/README.md | 4 +- packages/peer-store/README.md | 4 +- packages/pnet/README.md | 4 +- packages/protocol-autonat/README.md | 4 +- packages/protocol-dcutr/README.md | 4 +- packages/protocol-echo/README.md | 4 +- packages/protocol-fetch/README.md | 4 +- packages/protocol-identify/README.md | 4 +- packages/protocol-perf/README.md | 4 +- packages/protocol-ping/README.md | 4 +- packages/pubsub-floodsub/README.md | 4 +- packages/pubsub/README.md | 4 +- packages/record/README.md | 4 +- packages/stream-multiplexer-mplex/README.md | 4 +- packages/transport-circuit-relay-v2/README.md | 4 +- packages/transport-tcp/README.md | 4 +- packages/transport-webrtc/README.md | 4 +- packages/transport-websockets/README.md | 4 +- packages/transport-webtransport/README.md | 4 +- packages/upnp-nat/README.md | 4 +- packages/utils/README.md | 4 +- 48 files changed, 143 insertions(+), 143 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0951365da9..d72a10c300 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,12 @@ # Contributing guidelines -👋 Contributions are welcome! +👋 Contributions are welcome! 👉 Please see the [IPFS JavaScript Community contributing guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for how to collaborate and contribute to js-libp2p. -💪 The [core maintainers](./CODEOWNERS) hang out in #libp2p-implementers in ipfs.io Matrix, FIL Slack, and IPFS Discord. They perform weekly triage of issues and PRs per https://lu.ma/js-libp2p +💪 The [core maintainers](https://github.com/libp2p/js-libp2p/blob/main/CODEOWNERS) hang out in #libp2p-implementers in ipfs.io Matrix, FIL Slack, and IPFS Discord. They perform weekly triage of issues and PRs per https://lu.ma/js-libp2p -🤲 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 in [README.md](./README.md), without any additional terms or conditions. +🤲 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 in [README.md](https://github.com/libp2p/js-libp2p/blob/main/README.md), without any additional terms or conditions. 🔒 For security related issues please file a [private security vulnerability report](https://github.com/libp2p/js-libp2p/security/advisories/new). Please do not file a public issue on GitHub. diff --git a/README.md b/README.md index 4c0754f1ea..52d5718282 100644 --- a/README.md +++ b/README.md @@ -43,9 +43,9 @@ The documentation in the main branch may contain changes from a pre-release. If you are looking for the documentation of the latest release, you can view the latest release on [**npm**](https://www.npmjs.com/package/libp2p), or select the tag in github that matches the version you are looking for. -**Want to get started?** Check our [GETTING\_STARTED.md](./doc/GETTING_STARTED.md) guide and [examples](https://github.com/libp2p/js-libp2p-examples). +**Want to get started?** Check our [GETTING\_STARTED.md](https://github.com/libp2p/js-libp2p/blob/main/doc/GETTING_STARTED.md) guide and [examples](https://github.com/libp2p/js-libp2p-examples). -**Want to update libp2p in your project?** Check our [migrations folder](./doc/migrations). +**Want to update libp2p in your project?** Check our [migrations folder](https://github.com/libp2p/js-libp2p/tree/main/doc/migrations). ## Table of contents @@ -102,15 +102,15 @@ npm install libp2p ### Configuration -For all the information on how you can configure libp2p see [CONFIGURATION.md](./doc/CONFIGURATION.md). +For all the information on how you can configure libp2p see [CONFIGURATION.md](https://github.com/libp2p/js-libp2p/blob/main/doc/CONFIGURATION.md). ### Limits -For help configuring your node to resist malicious network peers, see [LIMITS.md](./doc/LIMITS.md) +For help configuring your node to resist malicious network peers, see [LIMITS.md](https://github.com/libp2p/js-libp2p/blob/main/doc/LIMITS.md) ### Getting started -If you are starting your journey with `js-libp2p`, read the [GETTING\_STARTED.md](./doc/GETTING_STARTED.md) guide. +If you are starting your journey with `js-libp2p`, read the [GETTING\_STARTED.md](https://github.com/libp2p/js-libp2p/blob/main/doc/GETTING_STARTED.md) guide. ### Tutorials and Examples @@ -118,36 +118,36 @@ You can find multiple examples on the [examples repo](https://github.com/libp2p/ ## Structure -- [`/doc`](./doc) Docs for libp2p -- [`/interop`](./interop) Multidimension Interop Test -- [`/packages/crypto`](./packages/crypto) Crypto primitives for libp2p -- [`/packages/interface`](./packages/interface) The interface implemented by a libp2p node -- [`/packages/interface-compliance-tests`](./packages/interface-compliance-tests) Compliance tests for JS libp2p interfaces -- [`/packages/interface-internal`](./packages/interface-internal) Interfaces implemented by internal libp2p components -- [`/packages/kad-dht`](./packages/kad-dht) JavaScript implementation of the Kad-DHT for libp2p -- [`/packages/keychain`](./packages/keychain) Key management and cryptographically protected messages -- [`/packages/libp2p`](./packages/libp2p) JavaScript implementation of libp2p, a modular peer to peer network stack -- [`/packages/logger`](./packages/logger) A logging component for use in js-libp2p modules -- [`/packages/metrics-prometheus`](./packages/metrics-prometheus) Collect libp2p metrics for scraping by Prometheus or Graphana -- [`/packages/multistream-select`](./packages/multistream-select) JavaScript implementation of multistream-select -- [`/packages/peer-collections`](./packages/peer-collections) Stores values against a peer id -- [`/packages/peer-discovery-bootstrap`](./packages/peer-discovery-bootstrap) Peer discovery via a list of bootstrap peers -- [`/packages/peer-discovery-mdns`](./packages/peer-discovery-mdns) Node.js libp2p mDNS discovery implementation for peer discovery -- [`/packages/peer-id`](./packages/peer-id) Implementation of @libp2p/interface-peer-id -- [`/packages/peer-id-factory`](./packages/peer-id-factory) Create PeerId instances -- [`/packages/peer-record`](./packages/peer-record) Used to transfer signed peer data across the network -- [`/packages/peer-store`](./packages/peer-store) Stores information about peers libp2p knows on the network -- [`/packages/protocol-echo`](./packages/protocol-echo) Implementation of an Echo protocol -- [`/packages/protocol-perf`](./packages/protocol-perf) Implementation of the Perf protocol -- [`/packages/pubsub`](./packages/pubsub) libp2p pubsub base class -- [`/packages/pubsub-floodsub`](./packages/pubsub-floodsub) libp2p-floodsub, also known as pubsub-flood or just dumbsub, this implementation of pubsub focused on delivering an API for Publish/Subscribe, but with no CastTree Forming (it just floods the network). -- [`/packages/record`](./packages/record) libp2p record implementation -- [`/packages/stream-multiplexer-mplex`](./packages/stream-multiplexer-mplex) JavaScript implementation of -- [`/packages/transport-tcp`](./packages/transport-tcp) A TCP transport for libp2p -- [`/packages/transport-webrtc`](./packages/transport-webrtc) A libp2p transport using WebRTC connections -- [`/packages/transport-websockets`](./packages/transport-websockets) JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport spec -- [`/packages/transport-webtransport`](./packages/transport-webtransport) JavaScript implementation of the WebTransport module that libp2p uses and that implements the interface-transport spec -- [`/packages/utils`](./packages/utils) Package to aggregate shared logic and dependencies for the libp2p ecosystem +- [`/doc`](https://github.com/libp2p/js-libp2p/blob/main/doc) Docs for libp2p +- [`/interop`](https://github.com/libp2p/js-libp2p/tree/main/interop) Multidimension Interop Test +- [`/packages/crypto`](https://github.com/libp2p/js-libp2p/tree/main/packages/crypto) Crypto primitives for libp2p +- [`/packages/interface`](https://github.com/libp2p/js-libp2p/tree/main/packages/interface) The interface implemented by a libp2p node +- [`/packages/interface-compliance-tests`](https://github.com/libp2p/js-libp2p/tree/main/packages/interface-compliance-tests) Compliance tests for JS libp2p interfaces +- [`/packages/interface-internal`](https://github.com/libp2p/js-libp2p/tree/main/packages/interface-internal) Interfaces implemented by internal libp2p components +- [`/packages/kad-dht`](https://github.com/libp2p/js-libp2p/tree/main/packages/kad-dht) JavaScript implementation of the Kad-DHT for libp2p +- [`/packages/keychain`](https://github.com/libp2p/js-libp2p/tree/main/packages/keychain) Key management and cryptographically protected messages +- [`/packages/libp2p`](https://github.com/libp2p/js-libp2p/tree/main/packages/libp2p) JavaScript implementation of libp2p, a modular peer to peer network stack +- [`/packages/logger`](https://github.com/libp2p/js-libp2p/tree/main/packages/logger) A logging component for use in js-libp2p modules +- [`/packages/metrics-prometheus`](https://github.com/libp2p/js-libp2p/tree/main/packages/metrics-prometheus) Collect libp2p metrics for scraping by Prometheus or Graphana +- [`/packages/multistream-select`](https://github.com/libp2p/js-libp2p/tree/main/packages/multistream-select) JavaScript implementation of multistream-select +- [`/packages/peer-collections`](https://github.com/libp2p/js-libp2p/tree/main/packages/peer-collections) Stores values against a peer id +- [`/packages/peer-discovery-bootstrap`](https://github.com/libp2p/js-libp2p/tree/main/packages/peer-discovery-bootstrap) Peer discovery via a list of bootstrap peers +- [`/packages/peer-discovery-mdns`](https://github.com/libp2p/js-libp2p/tree/main/packages/peer-discovery-mdns) Node.js libp2p mDNS discovery implementation for peer discovery +- [`/packages/peer-id`](https://github.com/libp2p/js-libp2p/tree/main/packages/peer-id) Implementation of @libp2p/interface-peer-id +- [`/packages/peer-id-factory`](https://github.com/libp2p/js-libp2p/tree/main/packages/peer-id-factory) Create PeerId instances +- [`/packages/peer-record`](https://github.com/libp2p/js-libp2p/tree/main/packages/peer-record) Used to transfer signed peer data across the network +- [`/packages/peer-store`](https://github.com/libp2p/js-libp2p/tree/main/packages/peer-store) Stores information about peers libp2p knows on the network +- [`/packages/protocol-echo`](https://github.com/libp2p/js-libp2p/tree/main/packages/protocol-echo) Implementation of an Echo protocol +- [`/packages/protocol-perf`](https://github.com/libp2p/js-libp2p/tree/main/packages/protocol-perf) Implementation of the Perf protocol +- [`/packages/pubsub`](https://github.com/libp2p/js-libp2p/tree/main/packages/pubsub) libp2p pubsub base class +- [`/packages/pubsub-floodsub`](https://github.com/libp2p/js-libp2p/tree/main/packages/pubsub-floodsub) libp2p-floodsub, also known as pubsub-flood or just dumbsub, this implementation of pubsub focused on delivering an API for Publish/Subscribe, but with no CastTree Forming (it just floods the network). +- [`/packages/record`](https://github.com/libp2p/js-libp2p/tree/main/packages/record) libp2p record implementation +- [`/packages/stream-multiplexer-mplex`](https://github.com/libp2p/js-libp2p/tree/main/packages/stream-multiplexer-mplex) JavaScript implementation of +- [`/packages/transport-tcp`](https://github.com/libp2p/js-libp2p/tree/main/packages/transport-tcp) A TCP transport for libp2p +- [`/packages/transport-webrtc`](https://github.com/libp2p/js-libp2p/tree/main/packages/transport-webrtc) A libp2p transport using WebRTC connections +- [`/packages/transport-websockets`](https://github.com/libp2p/js-libp2p/tree/main/packages/transport-websockets) JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport spec +- [`/packages/transport-webtransport`](https://github.com/libp2p/js-libp2p/tree/main/packages/transport-webtransport) JavaScript implementation of the WebTransport module that libp2p uses and that implements the interface-transport spec +- [`/packages/utils`](https://github.com/libp2p/js-libp2p/tree/main/packages/utils) Package to aggregate shared logic and dependencies for the libp2p ecosystem ## Development @@ -233,7 +233,7 @@ And [many others...](https://github.com/libp2p/js-libp2p/network/dependents) ## Contribute -See [CONTRIBUTING.md](./CONTRIBUTING.md). +See [CONTRIBUTING.md](https://github.com/libp2p/js-libp2p/tree/main/CONTRIBUTING.md). ## API Docs @@ -243,5 +243,5 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md). Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/LICENSE-MIT) / ) diff --git a/doc/CONFIGURATION.md b/doc/CONFIGURATION.md index b6959668ea..2d923fe2e2 100644 --- a/doc/CONFIGURATION.md +++ b/doc/CONFIGURATION.md @@ -42,9 +42,9 @@ libp2p is a modular networking stack. It's designed to be able to suit a variety of project needs. The configuration of libp2p is a key part of its structure. It enables you to bring exactly what you need, and only what you need. This document is a guide on how to configure libp2p for your particular project. Check out the [Configuration examples](#configuration-examples) section if you're just looking to leverage an existing configuration. -Regardless of how you configure libp2p, the top level [API](./API.md) will always remain the same. **Note**: if some modules are not configured, like Content Routing, using those methods will throw errors. +Regardless of how you configure libp2p, the top level [API](https://github.com/libp2p/js-libp2p/blob/main/doc/API.md) will always remain the same. **Note**: if some modules are not configured, like Content Routing, using those methods will throw errors. -To get a high-level overview of the js-libp2p architecture, please read the [Architecture](./ARCHITECTURE.md) document. +To get a high-level overview of the js-libp2p architecture, please read the [Architecture](https://github.com/libp2p/js-libp2p/blob/main/doc/ARCHITECTURE.md) document. ## Modules @@ -201,7 +201,7 @@ If you want to know more about libp2p pubsub, you should read the following cont ## Customizing libp2p -When [creating a libp2p node](./API.md#create), there are a number of services which are optional but will probably be needed for your use case such as the [kademlia](#dht), [peer discovery](#peer-discovery) and [pubsub](#pubsub) services for example. These are passed into the `services` object upon creating a node. You can also pass in custom services that will be used to create the node. This is done by providing your custom implementation to the `services` object, which should have the following structure: +When [creating a libp2p node](https://github.com/libp2p/js-libp2p/blob/main/doc/API.md#create), there are a number of services which are optional but will probably be needed for your use case such as the [kademlia](#dht), [peer discovery](#peer-discovery) and [pubsub](#pubsub) services for example. These are passed into the `services` object upon creating a node. You can also pass in custom services that will be used to create the node. This is done by providing your custom implementation to the `services` object, which should have the following structure: ```js const modules = { @@ -1021,4 +1021,4 @@ The [examples repo](https://github.com/libp2p/js-libp2p-examples) is also a good ## Limits -Configuring the various limits of your node is important to protect it when it is part of hostile of adversarial networks. See [LIMITS.md](./LIMITS.md) for a full breakdown of the various built in protections and safeguards. +Configuring the various limits of your node is important to protect it when it is part of hostile of adversarial networks. See [LIMITS.md](https://github.com/libp2p/js-libp2p/tree/main/doc/LIMITS.md) for a full breakdown of the various built in protections and safeguards. diff --git a/doc/GETTING_STARTED.md b/doc/GETTING_STARTED.md index 52403ac79e..fa6d15ecf5 100644 --- a/doc/GETTING_STARTED.md +++ b/doc/GETTING_STARTED.md @@ -28,7 +28,7 @@ npm install libp2p ## Configuring libp2p -If you're new to libp2p, we recommend configuring your node in stages, as this can make troubleshooting configuration issues much easier. In this guide, we'll do just that. If you're more experienced with libp2p, you may wish to jump to the [Configuration readme](./CONFIGURATION.md). +If you're new to libp2p, we recommend configuring your node in stages, as this can make troubleshooting configuration issues much easier. In this guide, we'll do just that. If you're more experienced with libp2p, you may wish to jump to the [Configuration readme](https://github.com/libp2p/js-libp2p/blob/main/doc/CONFIGURATION.md). ### ESM @@ -59,7 +59,7 @@ Now that we have libp2p installed, let's configure the minimum needed to get you Libp2p uses Transports to establish connections between peers over the network. Transports are the components responsible for performing the actual exchange of data between libp2p nodes. You can configure any number of Transports, but you only need 1 to start with. Supporting more Transports will improve the ability of your node to speak to a larger number of nodes on the network, as matching Transports are required for two nodes to communicate with one another. -You should select Transports according to the runtime of your application; Node.js or the browser. You can see a list of some of the available Transports in the [configuration readme](./CONFIGURATION.md#transport). For this guide let's install `@libp2p/websockets`, as it can be used in both Node.js and the browser. +You should select Transports according to the runtime of your application; Node.js or the browser. You can see a list of some of the available Transports in the [configuration readme](https://github.com/libp2p/js-libp2p/blob/main/doc/CONFIGURATION.md#transport). For this guide let's install `@libp2p/websockets`, as it can be used in both Node.js and the browser. Start by installing `@libp2p/websockets`: @@ -67,7 +67,7 @@ Start by installing `@libp2p/websockets`: npm install @libp2p/websockets ``` -Now that we have the module installed, let's configure libp2p to use the Transport. We'll use the [`Libp2p.create`](./API.md#create) method, which takes a single configuration object as its only parameter. We can add the Transport by passing it into the `modules.transport` array: +Now that we have the module installed, let's configure libp2p to use the Transport. We'll use the [`Libp2p.create`](https://github.com/libp2p/js-libp2p/blob/main/doc/API.md#create) method, which takes a single configuration object as its only parameter. We can add the Transport by passing it into the `modules.transport` array: ```js import { createLibp2p } from 'libp2p' @@ -91,7 +91,7 @@ If you want to know more about libp2p transports, you should read the following Encryption is an important part of communicating on the libp2p network. Every connection must be encrypted to help ensure security for everyone. As such, Connection Encryption (Crypto) is a required component of libp2p. -There are a growing number of Crypto modules being developed for libp2p. As those are released they will be tracked in the [Connection Encryption section of the configuration readme](./CONFIGURATION.md#connection-encryption). For now, we are going to configure our node to use the `@chainsafe/libp2p-noise` module. +There are a growing number of Crypto modules being developed for libp2p. As those are released they will be tracked in the [Connection Encryption section of the configuration readme](https://github.com/libp2p/js-libp2p/blob/main/doc/CONFIGURATION.md#connection-encryption). For now, we are going to configure our node to use the `@chainsafe/libp2p-noise` module. ```sh npm install @chainsafe/libp2p-noise @@ -121,7 +121,7 @@ If you want to know more about libp2p connection encryption, you should read the While multiplexers are not strictly required, they are highly recommended as they improve the effectiveness and efficiency of connections for the various protocols libp2p runs. Adding a multiplexer to your configuration will allow libp2p to run several of its internal protocols, like Identify, as well as allow your application to easily run any number of protocols over a single connection. -Looking at the [available stream multiplexing](./CONFIGURATION.md#stream-multiplexing) modules. Bear in mind that future libp2p Transports might have `multiplexing` capabilities already built-in (such as `QUIC`). +Looking at the [available stream multiplexing](https://github.com/libp2p/js-libp2p/blob/main/doc/CONFIGURATION.md#stream-multiplexing) modules. Bear in mind that future libp2p Transports might have `multiplexing` capabilities already built-in (such as `QUIC`). You can install `@chainsafe/libp2p-yamux` and add it to your libp2p node as follows in the next example. @@ -152,7 +152,7 @@ If you want to know more about libp2p stream multiplexing, you should read the f #### Running Libp2p -Now that you have configured a [**Transport**][transport], [**Crypto**][crypto] and [**Stream Multiplexer**](streamMuxer) module, you can start your libp2p node. We can start and stop libp2p using the [`libp2p.start()`](./API.md#start) and [`libp2p.stop()`](./API.md#stop) methods. +Now that you have configured a [**Transport**][transport], [**Crypto**][crypto] and [**Stream Multiplexer**](streamMuxer) module, you can start your libp2p node. We can start and stop libp2p using the [`libp2p.start()`](https://github.com/libp2p/js-libp2p/blob/main/doc/API.md#start) and [`libp2p.stop()`](https://github.com/libp2p/js-libp2p/blob/main/doc/API.md#stop) methods. ```ts import { createLibp2p } from 'libp2p' @@ -191,9 +191,9 @@ Once your libp2p node is running, it is time to get it connected to the public n Peer discovery is an important part of creating a well connected libp2p node. A static list of peers will often be used to join the network, but it's useful to couple other discovery mechanisms to ensure you're able to discover other peers that are important to your application. -For each discovered peer libp2p will emit a `peer:discovery` event which includes metadata about that peer. You can read the [Events](./API.md#events) in the API doc to learn more. +For each discovered peer libp2p will emit a `peer:discovery` event which includes metadata about that peer. You can read the [Events](https://github.com/libp2p/js-libp2p/tree/main/doc/API.md#events) in the API doc to learn more. -Looking at the [available peer discovery](./CONFIGURATION.md#peer-discovery) protocols, there are several options to be considered: +Looking at the [available peer discovery](https://github.com/libp2p/js-libp2p/blob/main/doc/CONFIGURATION.md#peer-discovery) protocols, there are several options to be considered: - If you already know the addresses of some other network peers, you should consider using `@libp2p/bootstrap` as this is the easiest way of getting your peer into the network. - If it is likely that you will have other peers on your local network, `@libp2p/mdns` is a must if you're node is not running in the browser. It allows peers to discover each other when on the same local network. - A random walk approach can be used via `@libp2p/kad-dht`, to crawl the network and find new peers along the way. @@ -273,7 +273,7 @@ localStorage.setItem('debug', 'libp2p:websockets,libp2p:webtransport,libp2p:kad- ## What is next -There are a lot of other concepts within `libp2p`, that are not covered in this guide. For additional configuration options we recommend checking out the [Configuration Readme](./CONFIGURATION.md) and the [examples repo](https://github.com/libp2p/js-libp2p-examples). If you have any problems getting started, or if anything isn't clear, please let us know by submitting an issue! +There are a lot of other concepts within `libp2p`, that are not covered in this guide. For additional configuration options we recommend checking out the [Configuration Readme](https://github.com/libp2p/js-libp2p/blob/main/doc/CONFIGURATION.md) and the [examples repo](https://github.com/libp2p/js-libp2p-examples). If you have any problems getting started, or if anything isn't clear, please let us know by submitting an issue! [transport]: https://github.com/libp2p/js-libp2p/tree/main/packages/interface/src/transport diff --git a/doc/METRICS.md b/doc/METRICS.md index d8fde01c5b..4b9f1293b4 100644 --- a/doc/METRICS.md +++ b/doc/METRICS.md @@ -13,7 +13,7 @@ Metrics allow you to gather run time statistics on your libp2p node. ## Overview - Metrics gathering is optional, as there is a performance hit to using it -- See the [API](./API.md) for Metrics usage. Metrics in libp2p do not emit events, as such applications wishing to read Metrics will need to do so actively. This ensures that the system is not unnecessarily firing update notifications. +- See the [API](https://github.com/libp2p/js-libp2p/blob/main/doc/API.md) for Metrics usage. Metrics in libp2p do not emit events, as such applications wishing to read Metrics will need to do so actively. This ensures that the system is not unnecessarily firing update notifications. - For large installations you may wish to combine the statistics with a visualizer such as [Graphana](https://grafana.com/) Although designed to primarily integrate with tools such as [Prometheus](https://prometheus.io/) it does not introduce any dependencies that require you to use any particular tool to store or graph metrics. diff --git a/doc/PEER_DISCOVERY.md b/doc/PEER_DISCOVERY.md index 2f03a3fdb1..ee0ddbb716 100644 --- a/doc/PEER_DISCOVERY.md +++ b/doc/PEER_DISCOVERY.md @@ -21,7 +21,7 @@ * All peers discovered are emitted via the `peer:discovery` event so applications can take any desired action * To ensure reasonable resource usage, discovered peers are not connected to automatically * Applications should lisen for the `peer:connect` event if they wish to take a specific action when new connections are established -* Libp2p functions best with a good number of network connections to a diverse set of peers. When the number of connected peers a node has falls under the [ConnectionManager](./CONFIGURATION.md#configuring-connection-manager) `minConnections` setting, randomly selected peers from the peer store will be dialed until the node's number of connections rises above this number. +* Libp2p functions best with a good number of network connections to a diverse set of peers. When the number of connected peers a node has falls under the [ConnectionManager](https://github.com/libp2p/js-libp2p/blob/main/doc/CONFIGURATION.md#configuring-connection-manager) `minConnections` setting, randomly selected peers from the peer store will be dialed until the node's number of connections rises above this number. * Applications can disable this behaviour by setting the `connectionManager.minConnections` config property to `0`, but they will have to manage increasing the current number of connections themselves. ## Scenarios @@ -44,7 +44,7 @@ Connect to more peers. ### 2. Connected to some -The node is connected to other nodes. The current number of connections is fewer than the desired amount, expressed as the [ConnectionManager](./CONFIGURATION.md#configuring-connection-manager) `minConnections` setting, also referred to as the low watermark. +The node is connected to other nodes. The current number of connections is fewer than the desired amount, expressed as the [ConnectionManager](https://github.com/libp2p/js-libp2p/blob/main/doc/CONFIGURATION.md#configuring-connection-manager) `minConnections` setting, also referred to as the low watermark. #### Action to take @@ -68,7 +68,7 @@ Avoiding dials above the `minConnections` also allows for a pool of connections ### 4. Connected to too many -The node has more connections than it wants. The current number of connections is greater than the desired amount, expressed as the [ConnectionManager](./CONFIGURATION.md#configuring-connection-manager) `maxOutgoingConnections` setting, also referred to as the high watermark. +The node has more connections than it wants. The current number of connections is greater than the desired amount, expressed as the [ConnectionManager](https://github.com/libp2p/js-libp2p/blob/main/doc/CONFIGURATION.md#configuring-connection-manager) `maxOutgoingConnections` setting, also referred to as the high watermark. #### Action to take diff --git a/doc/production/README.md b/doc/production/README.md index a8fa3d786e..ea706c7eaf 100644 --- a/doc/production/README.md +++ b/doc/production/README.md @@ -46,7 +46,7 @@ Aiming to support these type of nodes to find other peers and content in the net Currently, delegate nodes must be IPFS nodes as the IPFS HTTP API is leveraged by them to make routing queries. -You can read on how to setup your own set of delegated nodes in [DELEGATE_NODES.md](./DELEGATE_NODES.md). +You can read on how to setup your own set of delegated nodes in [DELEGATE_NODES.md](https://github.com/libp2p/js-libp2p/tree/main/doc/DELEGATE_NODES.md). ## Others diff --git a/interop/README.md b/interop/README.md index 54c683b889..f10057aa9e 100644 --- a/interop/README.md +++ b/interop/README.md @@ -116,8 +116,8 @@ $ docker run -e transport=tcp -e muxer=yamux -e security=noise -e is_dialer=fals Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/interop/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/interop/LICENSE-MIT) / ) # Contribution diff --git a/packages/connection-encrypter-plaintext/README.md b/packages/connection-encrypter-plaintext/README.md index 77fcd9ba52..ac9bf7191a 100644 --- a/packages/connection-encrypter-plaintext/README.md +++ b/packages/connection-encrypter-plaintext/README.md @@ -64,8 +64,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/connection-encrypter-plaintext/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/connection-encrypter-plaintext/LICENSE-MIT) / ) # Contribution diff --git a/packages/connection-encrypter-tls/README.md b/packages/connection-encrypter-tls/README.md index 70a1b1a95c..0ffa4c7db2 100644 --- a/packages/connection-encrypter-tls/README.md +++ b/packages/connection-encrypter-tls/README.md @@ -54,8 +54,8 @@ $ npm i @libp2p/tls Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/connection-encrypter-tls/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/connection-encrypter-tls/LICENSE-MIT) / ) # Contribution diff --git a/packages/crypto/README.md b/packages/crypto/README.md index 1ec49ec943..06adbe6f16 100644 --- a/packages/crypto/README.md +++ b/packages/crypto/README.md @@ -52,8 +52,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/crypto/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/crypto/LICENSE-MIT) / ) # Contribution diff --git a/packages/interface-compliance-tests/README.md b/packages/interface-compliance-tests/README.md index 9967afe3eb..3b1fdfa076 100644 --- a/packages/interface-compliance-tests/README.md +++ b/packages/interface-compliance-tests/README.md @@ -33,8 +33,8 @@ Each [interface](https://npmjs.org/packages/@libp2p/interfaces) has its document Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/interface-compliance-tests/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/interface-compliance-tests/LICENSE-MIT) / ) # Contribution diff --git a/packages/interface-internal/README.md b/packages/interface-internal/README.md index b3d0933474..0f48ed3d52 100644 --- a/packages/interface-internal/README.md +++ b/packages/interface-internal/README.md @@ -21,8 +21,8 @@ $ npm i @libp2p/interface-internal Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/interface-internal/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/interface-internal/LICENSE-MIT) / ) # Contribution diff --git a/packages/interface/README.md b/packages/interface/README.md index 2b99c5c558..4a940d394f 100644 --- a/packages/interface/README.md +++ b/packages/interface/README.md @@ -50,8 +50,8 @@ $ npm i @libp2p/interface Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/interface/LICENSE-MIT) / ) # Contribution diff --git a/packages/kad-dht/README.md b/packages/kad-dht/README.md index cb540d7d7c..7d5c50f9c8 100644 --- a/packages/kad-dht/README.md +++ b/packages/kad-dht/README.md @@ -124,8 +124,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/kad-dht/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/kad-dht/LICENSE-MIT) / ) # Contribution diff --git a/packages/keychain/README.md b/packages/keychain/README.md index e611fb6522..108521bcf8 100644 --- a/packages/keychain/README.md +++ b/packages/keychain/README.md @@ -65,7 +65,7 @@ const defaultOptions = { } ``` -![key storage](./doc/private-key.png?raw=true) +![key storage](https://github.com/libp2p/js-libp2p/blob/main/doc/private-key.png?raw=true) ## Physical storage @@ -95,8 +95,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/keychain/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/keychain/LICENSE-MIT) / ) # Contribution diff --git a/packages/keychain/src/index.ts b/packages/keychain/src/index.ts index fa606d46d3..03fdfd8702 100644 --- a/packages/keychain/src/index.ts +++ b/packages/keychain/src/index.ts @@ -42,7 +42,7 @@ * } * ``` * - * ![key storage](./doc/private-key.png?raw=true) + * ![key storage](https://github.com/libp2p/js-libp2p/blob/main/doc/private-key.png?raw=true) * * ## Physical storage * diff --git a/packages/libp2p/README.md b/packages/libp2p/README.md index c7c6977bee..e4f41b4779 100644 --- a/packages/libp2p/README.md +++ b/packages/libp2p/README.md @@ -86,15 +86,15 @@ It is complementary to the overarching libp2p project roadmap: ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/libp2p/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/libp2p/LICENSE-MIT) / ) # Contribution diff --git a/packages/libp2p/src/index.ts b/packages/libp2p/src/index.ts index aeb24cd382..82542aa6f7 100644 --- a/packages/libp2p/src/index.ts +++ b/packages/libp2p/src/index.ts @@ -29,7 +29,7 @@ export type ServiceFactoryMap = Record }> { /** diff --git a/packages/logger/README.md b/packages/logger/README.md index 16ed4e4c99..a0dd0cfc89 100644 --- a/packages/logger/README.md +++ b/packages/logger/README.md @@ -76,8 +76,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/logger/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/logger/LICENSE-MIT) / ) # Contribution diff --git a/packages/metrics-prometheus/README.md b/packages/metrics-prometheus/README.md index 51a7b349c6..35cc0aaee4 100644 --- a/packages/metrics-prometheus/README.md +++ b/packages/metrics-prometheus/README.md @@ -102,8 +102,8 @@ $ npm i @libp2p/prometheus-metrics Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/metrics-prometheus/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/metrics-prometheus/LICENSE-MIT) / ) # Contribution diff --git a/packages/multistream-select/README.md b/packages/multistream-select/README.md index 023a257266..6352f0b8d8 100644 --- a/packages/multistream-select/README.md +++ b/packages/multistream-select/README.md @@ -64,8 +64,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/multistream-select/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/multistream-select/LICENSE-MIT) / ) # Contribution diff --git a/packages/peer-collections/README.md b/packages/peer-collections/README.md index 2e9d293e36..24a8cd4501 100644 --- a/packages/peer-collections/README.md +++ b/packages/peer-collections/README.md @@ -130,8 +130,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-collections/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-collections/LICENSE-MIT) / ) # Contribution diff --git a/packages/peer-discovery-bootstrap/README.md b/packages/peer-discovery-bootstrap/README.md index bd7cc041df..d7b521e0bc 100644 --- a/packages/peer-discovery-bootstrap/README.md +++ b/packages/peer-discovery-bootstrap/README.md @@ -76,8 +76,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-discovery-bootstrap/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-discovery-bootstrap/LICENSE-MIT) / ) # Contribution diff --git a/packages/peer-discovery-mdns/README.md b/packages/peer-discovery-mdns/README.md index 9014f79b5c..34e14cde6b 100644 --- a/packages/peer-discovery-mdns/README.md +++ b/packages/peer-discovery-mdns/README.md @@ -112,8 +112,8 @@ $ npm i @libp2p/mdns Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-discovery-mdns/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-discovery-mdns/LICENSE-MIT) / ) # Contribution diff --git a/packages/peer-id-factory/README.md b/packages/peer-id-factory/README.md index 41f8c43892..3771083132 100644 --- a/packages/peer-id-factory/README.md +++ b/packages/peer-id-factory/README.md @@ -65,8 +65,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-id-factory/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-id-factory/LICENSE-MIT) / ) # Contribution diff --git a/packages/peer-id/README.md b/packages/peer-id/README.md index d75a9708db..4a6584a3ab 100644 --- a/packages/peer-id/README.md +++ b/packages/peer-id/README.md @@ -58,8 +58,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-id/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-id/LICENSE-MIT) / ) # Contribution diff --git a/packages/peer-record/README.md b/packages/peer-record/README.md index 39b309cb2d..f9a447af66 100644 --- a/packages/peer-record/README.md +++ b/packages/peer-record/README.md @@ -168,8 +168,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-record/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-record/LICENSE-MIT) / ) # Contribution diff --git a/packages/peer-store/README.md b/packages/peer-store/README.md index 36da486788..22062f3541 100644 --- a/packages/peer-store/README.md +++ b/packages/peer-store/README.md @@ -48,8 +48,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-store/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/peer-store/LICENSE-MIT) / ) # Contribution diff --git a/packages/pnet/README.md b/packages/pnet/README.md index 746c9b13e1..2b352a4f3d 100644 --- a/packages/pnet/README.md +++ b/packages/pnet/README.md @@ -100,8 +100,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/pnet/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/pnet/LICENSE-MIT) / ) # Contribution diff --git a/packages/protocol-autonat/README.md b/packages/protocol-autonat/README.md index c52d6a9d09..0b64e00252 100644 --- a/packages/protocol-autonat/README.md +++ b/packages/protocol-autonat/README.md @@ -75,8 +75,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/protocol-autonat/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/protocol-autonat/LICENSE-MIT) / ) # Contribution diff --git a/packages/protocol-dcutr/README.md b/packages/protocol-dcutr/README.md index 7483d05ce1..674e4842aa 100644 --- a/packages/protocol-dcutr/README.md +++ b/packages/protocol-dcutr/README.md @@ -99,8 +99,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/protocol-dcutr/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/protocol-dcutr/LICENSE-MIT) / ) # Contribution diff --git a/packages/protocol-echo/README.md b/packages/protocol-echo/README.md index 20355b09a9..acfc220eeb 100644 --- a/packages/protocol-echo/README.md +++ b/packages/protocol-echo/README.md @@ -86,8 +86,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/protocol-echo/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/protocol-echo/LICENSE-MIT) / ) # Contribution diff --git a/packages/protocol-fetch/README.md b/packages/protocol-fetch/README.md index 70a96ba41b..c31e893db1 100644 --- a/packages/protocol-fetch/README.md +++ b/packages/protocol-fetch/README.md @@ -85,8 +85,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/protocol-fetch/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/protocol-fetch/LICENSE-MIT) / ) # Contribution diff --git a/packages/protocol-identify/README.md b/packages/protocol-identify/README.md index 351a9c53f8..35891e5966 100644 --- a/packages/protocol-identify/README.md +++ b/packages/protocol-identify/README.md @@ -62,8 +62,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/protocol-identify/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/protocol-identify/LICENSE-MIT) / ) # Contribution diff --git a/packages/protocol-perf/README.md b/packages/protocol-perf/README.md index 738fef4ce3..09b8829e79 100644 --- a/packages/protocol-perf/README.md +++ b/packages/protocol-perf/README.md @@ -96,8 +96,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/protocol-perf/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/protocol-perf/LICENSE-MIT) / ) # Contribution diff --git a/packages/protocol-ping/README.md b/packages/protocol-ping/README.md index b75d834209..4b45020294 100644 --- a/packages/protocol-ping/README.md +++ b/packages/protocol-ping/README.md @@ -66,8 +66,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/protocol-ping/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/protocol-ping/LICENSE-MIT) / ) # Contribution diff --git a/packages/pubsub-floodsub/README.md b/packages/pubsub-floodsub/README.md index 9e32f793ac..3b3292a122 100644 --- a/packages/pubsub-floodsub/README.md +++ b/packages/pubsub-floodsub/README.md @@ -76,8 +76,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/pubsub-floodsub/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/pubsub-floodsub/LICENSE-MIT) / ) # Contribution diff --git a/packages/pubsub/README.md b/packages/pubsub/README.md index d33765739f..b8678e4f58 100644 --- a/packages/pubsub/README.md +++ b/packages/pubsub/README.md @@ -74,8 +74,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/pubsub/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/pubsub/LICENSE-MIT) / ) # Contribution diff --git a/packages/record/README.md b/packages/record/README.md index 944df06e8f..213e37eebd 100644 --- a/packages/record/README.md +++ b/packages/record/README.md @@ -70,8 +70,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/record/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/record/LICENSE-MIT) / ) # Contribution diff --git a/packages/stream-multiplexer-mplex/README.md b/packages/stream-multiplexer-mplex/README.md index 3e21955a9a..b1c317e5f4 100644 --- a/packages/stream-multiplexer-mplex/README.md +++ b/packages/stream-multiplexer-mplex/README.md @@ -31,8 +31,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/stream-multiplexer-mplex/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/stream-multiplexer-mplex/LICENSE-MIT) / ) # Contribution diff --git a/packages/transport-circuit-relay-v2/README.md b/packages/transport-circuit-relay-v2/README.md index c2a41f7156..d1a0ef5b62 100644 --- a/packages/transport-circuit-relay-v2/README.md +++ b/packages/transport-circuit-relay-v2/README.md @@ -83,8 +83,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/transport-circuit-relay-v2/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/transport-circuit-relay-v2/LICENSE-MIT) / ) # Contribution diff --git a/packages/transport-tcp/README.md b/packages/transport-tcp/README.md index b9069e7990..8a23e887b5 100644 --- a/packages/transport-tcp/README.md +++ b/packages/transport-tcp/README.md @@ -63,8 +63,8 @@ $ npm i @libp2p/tcp Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/transport-tcp/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/transport-tcp/LICENSE-MIT) / ) # Contribution diff --git a/packages/transport-webrtc/README.md b/packages/transport-webrtc/README.md index 655ff3ccf7..24c7f89ac3 100644 --- a/packages/transport-webrtc/README.md +++ b/packages/transport-webrtc/README.md @@ -235,8 +235,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/transport-webrtc/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/transport-webrtc/LICENSE-MIT) / ) # Contribution diff --git a/packages/transport-websockets/README.md b/packages/transport-websockets/README.md index 326fe971cc..0bee4634cd 100644 --- a/packages/transport-websockets/README.md +++ b/packages/transport-websockets/README.md @@ -101,8 +101,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/transport-websockets/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/transport-websockets/LICENSE-MIT) / ) # Contribution diff --git a/packages/transport-webtransport/README.md b/packages/transport-webtransport/README.md index 91c6678e22..80122f6ea5 100644 --- a/packages/transport-webtransport/README.md +++ b/packages/transport-webtransport/README.md @@ -71,8 +71,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/transport-webtransport/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/transport-webtransport/LICENSE-MIT) / ) # Contribution diff --git a/packages/upnp-nat/README.md b/packages/upnp-nat/README.md index 4f021f6de8..fa368ce826 100644 --- a/packages/upnp-nat/README.md +++ b/packages/upnp-nat/README.md @@ -71,8 +71,8 @@ $ npm i @libp2p/upnp-nat Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/upnp-nat/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/upnp-nat/LICENSE-MIT) / ) # Contribution diff --git a/packages/utils/README.md b/packages/utils/README.md index adfbef4404..90bceb44b6 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -63,8 +63,8 @@ Loading this module through a script tag will make it's exports available as `Li Licensed under either of -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) +- Apache 2.0, ([LICENSE-APACHE](https://github.com/libp2p/js-libp2p/blob/main/packages/utils/LICENSE-APACHE) / ) +- MIT ([LICENSE-MIT](https://github.com/libp2p/js-libp2p/blob/main/packages/utils/LICENSE-MIT) / ) # Contribution