You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
# Contributing guidelines
2
2
3
-
👋 Contributions are welcome!
3
+
👋 Contributions are welcome!
4
4
5
5
👉 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.
6
6
7
-
💪 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
7
+
💪 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
8
8
9
-
🤲 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.
9
+
🤲 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.
10
10
11
11
🔒 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.
Copy file name to clipboardExpand all lines: README.md
+38-38
Original file line number
Diff line number
Diff line change
@@ -43,9 +43,9 @@ The documentation in the main branch may contain changes from a pre-release.
43
43
44
44
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.
45
45
46
-
**Want to get started?** Check our [GETTING\_STARTED.md](./doc/GETTING_STARTED.md) guide and [examples](https://github.com/libp2p/js-libp2p-examples).
46
+
**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).
47
47
48
-
**Want to update libp2p in your project?** Check our [migrations folder](./doc/migrations).
48
+
**Want to update libp2p in your project?** Check our [migrations folder](https://github.com/libp2p/js-libp2p/tree/main/doc/migrations).
49
49
50
50
## Table of contents <!-- omit in toc -->
51
51
@@ -102,52 +102,52 @@ npm install libp2p
102
102
103
103
### Configuration
104
104
105
-
For all the information on how you can configure libp2p see [CONFIGURATION.md](./doc/CONFIGURATION.md).
105
+
For all the information on how you can configure libp2p see [CONFIGURATION.md](https://github.com/libp2p/js-libp2p/blob/main/doc/CONFIGURATION.md).
106
106
107
107
### Limits
108
108
109
-
For help configuring your node to resist malicious network peers, see [LIMITS.md](./doc/LIMITS.md)
109
+
For help configuring your node to resist malicious network peers, see [LIMITS.md](https://github.com/libp2p/js-libp2p/blob/main/doc/LIMITS.md)
110
110
111
111
### Getting started
112
112
113
-
If you are starting your journey with `js-libp2p`, read the [GETTING\_STARTED.md](./doc/GETTING_STARTED.md) guide.
113
+
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.
114
114
115
115
### Tutorials and Examples
116
116
117
117
You can find multiple examples on the [examples repo](https://github.com/libp2p/js-libp2p-examples) that will guide you through using libp2p for several scenarios.
118
118
119
119
## Structure
120
120
121
-
-[`/doc`](./doc) Docs for libp2p
122
-
-[`/interop`](./interop) Multidimension Interop Test
123
-
-[`/packages/crypto`](./packages/crypto) Crypto primitives for libp2p
124
-
-[`/packages/interface`](./packages/interface) The interface implemented by a libp2p node
125
-
-[`/packages/interface-compliance-tests`](./packages/interface-compliance-tests) Compliance tests for JS libp2p interfaces
126
-
-[`/packages/interface-internal`](./packages/interface-internal) Interfaces implemented by internal libp2p components
127
-
-[`/packages/kad-dht`](./packages/kad-dht) JavaScript implementation of the Kad-DHT for libp2p
128
-
-[`/packages/keychain`](./packages/keychain) Key management and cryptographically protected messages
129
-
-[`/packages/libp2p`](./packages/libp2p) JavaScript implementation of libp2p, a modular peer to peer network stack
130
-
-[`/packages/logger`](./packages/logger) A logging component for use in js-libp2p modules
131
-
-[`/packages/metrics-prometheus`](./packages/metrics-prometheus) Collect libp2p metrics for scraping by Prometheus or Graphana
132
-
-[`/packages/multistream-select`](./packages/multistream-select) JavaScript implementation of multistream-select
133
-
-[`/packages/peer-collections`](./packages/peer-collections) Stores values against a peer id
134
-
-[`/packages/peer-discovery-bootstrap`](./packages/peer-discovery-bootstrap) Peer discovery via a list of bootstrap peers
135
-
-[`/packages/peer-discovery-mdns`](./packages/peer-discovery-mdns) Node.js libp2p mDNS discovery implementation for peer discovery
136
-
-[`/packages/peer-id`](./packages/peer-id) Implementation of @libp2p/interface-peer-id
-[`/packages/peer-record`](./packages/peer-record) Used to transfer signed peer data across the network
139
-
-[`/packages/peer-store`](./packages/peer-store) Stores information about peers libp2p knows on the network
140
-
-[`/packages/protocol-echo`](./packages/protocol-echo) Implementation of an Echo protocol
141
-
-[`/packages/protocol-perf`](./packages/protocol-perf) Implementation of the Perf protocol
142
-
-[`/packages/pubsub`](./packages/pubsub) libp2p pubsub base class
143
-
-[`/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).
144
-
-[`/packages/record`](./packages/record) libp2p record implementation
145
-
-[`/packages/stream-multiplexer-mplex`](./packages/stream-multiplexer-mplex) JavaScript implementation of <https://github.com/libp2p/mplex>
146
-
-[`/packages/transport-tcp`](./packages/transport-tcp) A TCP transport for libp2p
147
-
-[`/packages/transport-webrtc`](./packages/transport-webrtc) A libp2p transport using WebRTC connections
148
-
-[`/packages/transport-websockets`](./packages/transport-websockets) JavaScript implementation of the WebSockets module that libp2p uses and that implements the interface-transport spec
149
-
-[`/packages/transport-webtransport`](./packages/transport-webtransport) JavaScript implementation of the WebTransport module that libp2p uses and that implements the interface-transport spec
150
-
-[`/packages/utils`](./packages/utils) Package to aggregate shared logic and dependencies for the libp2p ecosystem
121
+
-[`/doc`](https://github.com/libp2p/js-libp2p/blob/main/doc) Docs for libp2p
122
+
-[`/interop`](https://github.com/libp2p/js-libp2p/tree/main/interop) Multidimension Interop Test
123
+
-[`/packages/crypto`](https://github.com/libp2p/js-libp2p/tree/main/packages/crypto) Crypto primitives for libp2p
124
+
-[`/packages/interface`](https://github.com/libp2p/js-libp2p/tree/main/packages/interface) The interface implemented by a libp2p node
125
+
-[`/packages/interface-compliance-tests`](https://github.com/libp2p/js-libp2p/tree/main/packages/interface-compliance-tests) Compliance tests for JS libp2p interfaces
126
+
-[`/packages/interface-internal`](https://github.com/libp2p/js-libp2p/tree/main/packages/interface-internal) Interfaces implemented by internal libp2p components
127
+
-[`/packages/kad-dht`](https://github.com/libp2p/js-libp2p/tree/main/packages/kad-dht) JavaScript implementation of the Kad-DHT for libp2p
128
+
-[`/packages/keychain`](https://github.com/libp2p/js-libp2p/tree/main/packages/keychain) Key management and cryptographically protected messages
129
+
-[`/packages/libp2p`](https://github.com/libp2p/js-libp2p/tree/main/packages/libp2p) JavaScript implementation of libp2p, a modular peer to peer network stack
130
+
-[`/packages/logger`](https://github.com/libp2p/js-libp2p/tree/main/packages/logger) A logging component for use in js-libp2p modules
131
+
-[`/packages/metrics-prometheus`](https://github.com/libp2p/js-libp2p/tree/main/packages/metrics-prometheus) Collect libp2p metrics for scraping by Prometheus or Graphana
132
+
-[`/packages/multistream-select`](https://github.com/libp2p/js-libp2p/tree/main/packages/multistream-select) JavaScript implementation of multistream-select
133
+
-[`/packages/peer-collections`](https://github.com/libp2p/js-libp2p/tree/main/packages/peer-collections) Stores values against a peer id
134
+
-[`/packages/peer-discovery-bootstrap`](https://github.com/libp2p/js-libp2p/tree/main/packages/peer-discovery-bootstrap) Peer discovery via a list of bootstrap peers
135
+
-[`/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
136
+
-[`/packages/peer-id`](https://github.com/libp2p/js-libp2p/tree/main/packages/peer-id) Implementation of @libp2p/interface-peer-id
-[`/packages/peer-record`](https://github.com/libp2p/js-libp2p/tree/main/packages/peer-record) Used to transfer signed peer data across the network
139
+
-[`/packages/peer-store`](https://github.com/libp2p/js-libp2p/tree/main/packages/peer-store) Stores information about peers libp2p knows on the network
140
+
-[`/packages/protocol-echo`](https://github.com/libp2p/js-libp2p/tree/main/packages/protocol-echo) Implementation of an Echo protocol
141
+
-[`/packages/protocol-perf`](https://github.com/libp2p/js-libp2p/tree/main/packages/protocol-perf) Implementation of the Perf protocol
142
+
-[`/packages/pubsub`](https://github.com/libp2p/js-libp2p/tree/main/packages/pubsub) libp2p pubsub base class
143
+
-[`/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).
144
+
-[`/packages/record`](https://github.com/libp2p/js-libp2p/tree/main/packages/record) libp2p record implementation
145
+
-[`/packages/stream-multiplexer-mplex`](https://github.com/libp2p/js-libp2p/tree/main/packages/stream-multiplexer-mplex) JavaScript implementation of <https://github.com/libp2p/mplex>
146
+
-[`/packages/transport-tcp`](https://github.com/libp2p/js-libp2p/tree/main/packages/transport-tcp) A TCP transport for libp2p
147
+
-[`/packages/transport-webrtc`](https://github.com/libp2p/js-libp2p/tree/main/packages/transport-webrtc) A libp2p transport using WebRTC connections
148
+
-[`/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
149
+
-[`/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
150
+
-[`/packages/utils`](https://github.com/libp2p/js-libp2p/tree/main/packages/utils) Package to aggregate shared logic and dependencies for the libp2p ecosystem
151
151
152
152
## Development
153
153
@@ -233,7 +233,7 @@ And [many others...](https://github.com/libp2p/js-libp2p/network/dependents)
233
233
234
234
## Contribute
235
235
236
-
See [CONTRIBUTING.md](./CONTRIBUTING.md).
236
+
See [CONTRIBUTING.md](https://github.com/libp2p/js-libp2p/tree/main/CONTRIBUTING.md).
237
237
238
238
## API Docs
239
239
@@ -243,5 +243,5 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md).
Copy file name to clipboardExpand all lines: doc/CONFIGURATION.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -42,9 +42,9 @@
42
42
43
43
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.
44
44
45
-
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.
45
+
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.
46
46
47
-
To get a high-level overview of the js-libp2p architecture, please read the [Architecture](./ARCHITECTURE.md) document.
47
+
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.
48
48
49
49
## Modules
50
50
@@ -201,7 +201,7 @@ If you want to know more about libp2p pubsub, you should read the following cont
201
201
202
202
## Customizing libp2p
203
203
204
-
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:
204
+
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:
205
205
206
206
```js
207
207
constmodules= {
@@ -1021,4 +1021,4 @@ The [examples repo](https://github.com/libp2p/js-libp2p-examples) is also a good
1021
1021
1022
1022
## Limits
1023
1023
1024
-
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.
1024
+
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.
0 commit comments