remove workspace and packages section from README (#1563)
* remove note about the libp2p workspace * remove repo table from README
This commit is contained in:
Marten Seemann
GitHub
parent
449bafb2a3
commit
0fcc5d26ef
81
README.md
81
README.md
|
|
@ -39,7 +39,7 @@ To learn more, check out the following resources:
|
|||
|
||||
## Usage
|
||||
|
||||
This repository (`go-libp2p`) serves as the entrypoint to the universe of modules that compose the Go implementation of the libp2p stack.
|
||||
This repository (`go-libp2p`) serves as the entrypoint to the universe of packages that compose the Go implementation of the libp2p stack.
|
||||
|
||||
You can start using go-libp2p in your Go application simply by adding imports from our repos, e.g.:
|
||||
|
||||
|
|
@ -53,89 +53,10 @@ Examples can be found in the [examples folder](examples).
|
|||
|
||||
## Development
|
||||
|
||||
### Using the go-libp2p Workspace
|
||||
|
||||
While developing, you may need to make changes to several modules at once, or you may want changes made locally in one module to be available for import by another.
|
||||
|
||||
The [go-libp2p workspace](https://github.com/libp2p/workspace-go-libp2p) provides a developer-oriented view of the modules that comprise go-libp2p.
|
||||
|
||||
Using the tooling in the workspace repository, you can checkout all of go-libp2p's module repos and enter "local mode", which adds [replace directives](https://github.com/golang/go/wiki/Modules#gomod) to the go.mod files in each local working copy. When you build locally, the libp2p depdendencies will be resolved from your local working copies.
|
||||
|
||||
Once you've committed your changes, you can switch back to "remote mode", which removes the replace directives and pulls imports from the main go module cache.
|
||||
|
||||
See the [workspace repo](https://github.com/libp2p/workspace-go-libp2p) for more information.
|
||||
|
||||
### Tests
|
||||
|
||||
`go test ./...` will run all tests in the repo.
|
||||
|
||||
### Packages
|
||||
|
||||
> This table is generated using the module [`package-table`](https://github.com/ipfs-shipyard/package-table) with `package-table --data=package-list.json`.
|
||||
|
||||
List of packages currently in existence for libp2p:
|
||||
|
||||
| Name | CI/Travis | Coverage | Description |
|
||||
| ---------|---------|---------|--------- |
|
||||
| **Libp2p** |
|
||||
| [`go-libp2p`](//github.com/libp2p/go-libp2p) | [](https://travis-ci.com/libp2p/go-libp2p) | [](https://codecov.io/gh/libp2p/go-libp2p) | go-libp2p entry point |
|
||||
| [`go-libp2p-core`](//github.com/libp2p/go-libp2p-core) | [](https://travis-ci.com/libp2p/go-libp2p-core) | [](https://codecov.io/gh/libp2p/go-libp2p-core) | core interfaces, types, and abstractions |
|
||||
| [`go-libp2p-blankhost`](//github.com/libp2p/go-libp2p-blankhost) | [](https://travis-ci.com/libp2p/go-libp2p-blankhost) | [](https://codecov.io/gh/libp2p/go-libp2p-blankhost) | minimal implementation of the "host" interface |
|
||||
| **Network** |
|
||||
| [`go-libp2p-swarm`](//github.com/libp2p/go-libp2p-swarm) | [](https://travis-ci.com/libp2p/go-libp2p-swarm) | [](https://codecov.io/gh/libp2p/go-libp2p-swarm) | reference implementation of network state machine |
|
||||
| **Transport** |
|
||||
| [`go-ws-transport`](//github.com/libp2p/go-ws-transport) | [](https://travis-ci.com/libp2p/go-ws-transport) | [](https://codecov.io/gh/libp2p/go-ws-transport) | WebSocket transport |
|
||||
| [`go-tcp-transport`](//github.com/libp2p/go-tcp-transport) | [](https://travis-ci.com/libp2p/go-tcp-transport) | [](https://codecov.io/gh/libp2p/go-tcp-transport) | TCP transport |
|
||||
| [`go-libp2p-quic-transport`](//github.com/libp2p/go-libp2p-quic-transport) | [](https://travis-ci.com/libp2p/go-libp2p-quic-transport) | [](https://codecov.io/gh/libp2p/go-libp2p-quic-transport) | QUIC transport |
|
||||
| [`go-udp-transport`](//github.com/libp2p/go-udp-transport) | [](https://travis-ci.com/libp2p/go-udp-transport) | [](https://codecov.io/gh/libp2p/go-udp-transport) | UDP transport |
|
||||
| [`go-utp-transport`](//github.com/libp2p/go-utp-transport) | [](https://travis-ci.com/libp2p/go-utp-transport) | [](https://codecov.io/gh/libp2p/go-utp-transport) | uTorrent transport (UTP) |
|
||||
| [`go-libp2p-circuit`](//github.com/libp2p/go-libp2p-circuit) | [](https://travis-ci.com/libp2p/go-libp2p-circuit) | [](https://codecov.io/gh/libp2p/go-libp2p-circuit) | relay transport |
|
||||
| [`go-libp2p-transport-upgrader`](//github.com/libp2p/go-libp2p-transport-upgrader) | [](https://travis-ci.com/libp2p/go-libp2p-transport-upgrader) | [](https://codecov.io/gh/libp2p/go-libp2p-transport-upgrader) | upgrades multiaddr-net connections into full libp2p transports |
|
||||
| [`go-libp2p-reuseport-transport`](//github.com/libp2p/go-libp2p-reuseport-transport) | [](https://travis-ci.com/libp2p/go-libp2p-reuseport-transport) | [](https://codecov.io/gh/libp2p/go-libp2p-reuseport-transport) | partial transport for building transports that reuse ports |
|
||||
| **Encrypted Channels** |
|
||||
| [`go-libp2p-noise`](//github.com/libp2p/go-libp2p-noise) | [](https://travis-ci.com/libp2p/go-libp2p-noise) | [](https://codecov.io/gh/libp2p/go-libp2p-noise) | Noise crypto channel |
|
||||
| [`go-libp2p-tls`](//github.com/libp2p/go-libp2p-tls) | [](https://travis-ci.com/libp2p/go-libp2p-tls) | [](https://codecov.io/gh/libp2p/go-libp2p-tls) | TLS 1.3+ crypto channel |
|
||||
| [`go-conn-security-multistream`](//github.com/libp2p/go-conn-security-multistream) | [](https://travis-ci.com/libp2p/go-conn-security-multistream) | [](https://codecov.io/gh/libp2p/go-conn-security-multistream) | multistream multiplexed meta crypto channel |
|
||||
| **Private Network** |
|
||||
| [`go-libp2p-pnet`](//github.com/libp2p/go-libp2p-pnet) | [](https://travis-ci.com/libp2p/go-libp2p-pnet) | [](https://codecov.io/gh/libp2p/go-libp2p-pnet) | reference private networking implementation |
|
||||
| **Stream Muxers** |
|
||||
| [`go-libp2p-yamux`](//github.com/libp2p/go-libp2p-yamux) | [](https://travis-ci.com/libp2p/go-libp2p-yamux) | [](https://codecov.io/gh/libp2p/go-libp2p-yamux) | YAMUX stream multiplexer |
|
||||
| [`go-libp2p-mplex`](//github.com/libp2p/go-libp2p-mplex) | [](https://travis-ci.com/libp2p/go-libp2p-mplex) | [](https://codecov.io/gh/libp2p/go-libp2p-mplex) | MPLEX stream multiplexer |
|
||||
| **NAT Traversal** |
|
||||
| [`go-libp2p-nat`](//github.com/libp2p/go-libp2p-nat) | [](https://travis-ci.com/libp2p/go-libp2p-nat) | [](https://codecov.io/gh/libp2p/go-libp2p-nat) | |
|
||||
| **Peerstore** |
|
||||
| [`go-libp2p-peerstore`](//github.com/libp2p/go-libp2p-peerstore) | [](https://travis-ci.com/libp2p/go-libp2p-peerstore) | [](https://codecov.io/gh/libp2p/go-libp2p-peerstore) | reference implementation of peer metadata storage component |
|
||||
| **Connection Manager** |
|
||||
| [`go-libp2p-connmgr`](//github.com/libp2p/go-libp2p-connmgr) | [](https://travis-ci.com/libp2p/go-libp2p-connmgr) | [](https://codecov.io/gh/libp2p/go-libp2p-connmgr) | reference implementation of connection manager |
|
||||
| **Routing** |
|
||||
| [`go-libp2p-record`](//github.com/libp2p/go-libp2p-record) | [](https://travis-ci.com/libp2p/go-libp2p-record) | [](https://codecov.io/gh/libp2p/go-libp2p-record) | record type and validator logic |
|
||||
| [`go-libp2p-kad-dht`](//github.com/libp2p/go-libp2p-kad-dht) | [](https://travis-ci.com/libp2p/go-libp2p-kad-dht) | [](https://codecov.io/gh/libp2p/go-libp2p-kad-dht) | Kademlia-like router |
|
||||
| [`go-libp2p-kbucket`](//github.com/libp2p/go-libp2p-kbucket) | [](https://travis-ci.com/libp2p/go-libp2p-kbucket) | [](https://codecov.io/gh/libp2p/go-libp2p-kbucket) | Kademlia routing table helper types |
|
||||
| [`go-libp2p-coral-dht`](//github.com/libp2p/go-libp2p-coral-dht) | [](https://travis-ci.com/libp2p/go-libp2p-coral-dht) | [](https://codecov.io/gh/libp2p/go-libp2p-coral-dht) | Router based on Coral DHT |
|
||||
| [`go-libp2p-pubsub-router`](//github.com/libp2p/go-libp2p-pubsub-router) | [](https://travis-ci.com/libp2p/go-libp2p-pubsub-router) | [](https://codecov.io/gh/libp2p/go-libp2p-pubsub-router) | record-store over pubsub adapter |
|
||||
| **Consensus** |
|
||||
| [`go-libp2p-consensus`](//github.com/libp2p/go-libp2p-consensus) | [](https://travis-ci.com/libp2p/go-libp2p-consensus) | [](https://codecov.io/gh/libp2p/go-libp2p-consensus) | consensus protocols interfaces |
|
||||
| [`go-libp2p-raft`](//github.com/libp2p/go-libp2p-raft) | [](https://travis-ci.com/libp2p/go-libp2p-raft) | [](https://codecov.io/gh/libp2p/go-libp2p-raft) | consensus implementation over raft |
|
||||
| **Pubsub** |
|
||||
| [`go-libp2p-pubsub`](//github.com/libp2p/go-libp2p-pubsub) | [](https://travis-ci.com/libp2p/go-libp2p-pubsub) | [](https://codecov.io/gh/libp2p/go-libp2p-pubsub) | multiple pubsub over libp2p implementations |
|
||||
| **RPC** |
|
||||
| [`go-libp2p-gorpc`](//github.com/libp2p/go-libp2p-gorpc) | [](https://travis-ci.com/libp2p/go-libp2p-gorpc) | [](https://codecov.io/gh/libp2p/go-libp2p-gorpc) | a simple RPC library for libp2p |
|
||||
| **Utilities/miscellaneous** |
|
||||
| [`go-libp2p-loggables`](//github.com/libp2p/go-libp2p-loggables) | [](https://travis-ci.com/libp2p/go-libp2p-loggables) | [](https://codecov.io/gh/libp2p/go-libp2p-loggables) | logging helpers |
|
||||
| [`go-maddr-filter`](//github.com/libp2p/go-maddr-filter) | [](https://travis-ci.com/libp2p/go-maddr-filter) | [](https://codecov.io/gh/libp2p/go-maddr-filter) | multiaddr filtering helpers |
|
||||
| [`go-libp2p-netutil`](//github.com/libp2p/go-libp2p-netutil) | [](https://travis-ci.com/libp2p/go-libp2p-netutil) | [](https://codecov.io/gh/libp2p/go-libp2p-netutil) | misc utilities |
|
||||
| [`go-msgio`](//github.com/libp2p/go-msgio) | [](https://travis-ci.com/libp2p/go-msgio) | [](https://codecov.io/gh/libp2p/go-msgio) | length prefixed data channel |
|
||||
| [`go-addr-util`](//github.com/libp2p/go-addr-util) | [](https://travis-ci.com/libp2p/go-addr-util) | [](https://codecov.io/gh/libp2p/go-addr-util) | address utilities for libp2p swarm |
|
||||
| [`go-buffer-pool`](//github.com/libp2p/go-buffer-pool) | [](https://travis-ci.com/libp2p/go-buffer-pool) | [](https://codecov.io/gh/libp2p/go-buffer-pool) | a variable size buffer pool for go |
|
||||
| [`go-libp2p-routing-helpers`](//github.com/libp2p/go-libp2p-routing-helpers) | [](https://travis-ci.com/libp2p/go-libp2p-routing-helpers) | [](https://codecov.io/gh/libp2p/go-libp2p-routing-helpers) | routing helpers |
|
||||
| [`go-reuseport`](//github.com/libp2p/go-reuseport) | [](https://travis-ci.com/libp2p/go-reuseport) | [](https://codecov.io/gh/libp2p/go-reuseport) | enables reuse of addresses |
|
||||
| [`go-sockaddr`](//github.com/libp2p/go-sockaddr) | [](https://travis-ci.com/libp2p/go-sockaddr) | [](https://codecov.io/gh/libp2p/go-sockaddr) | utils for sockaddr conversions |
|
||||
| [`go-flow-metrics`](//github.com/libp2p/go-flow-metrics) | [](https://travis-ci.com/libp2p/go-flow-metrics) | [](https://codecov.io/gh/libp2p/go-flow-metrics) | metrics library |
|
||||
| [`go-libp2p-gostream`](//github.com/libp2p/go-libp2p-gostream) | [](https://travis-ci.com/libp2p/go-libp2p-gostream) | [](https://codecov.io/gh/libp2p/go-libp2p-gostream) | Go 'net' wrappers for libp2p |
|
||||
| [`go-libp2p-http`](//github.com/libp2p/go-libp2p-http) | [](https://travis-ci.com/libp2p/go-libp2p-http) | [](https://codecov.io/gh/libp2p/go-libp2p-http) | HTTP on top of libp2p streams |
|
||||
| **Testing and examples** |
|
||||
| [`go-libp2p-testing`](//github.com/libp2p/go-libp2p-testing) | [](https://travis-ci.com/libp2p/go-libp2p-testing) | [](https://codecov.io/gh/libp2p/go-libp2p-testing) | a collection of testing utilities for libp2p |
|
||||
|
||||
# Contribute
|
||||
|
||||
go-libp2p is part of [The IPFS Project](https://github.com/ipfs/ipfs), and is MIT-licensed open source software. We welcome contributions big and small! Take a look at the [community contributing notes](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md). Please make sure to check the [issues](https://github.com/ipfs/go-libp2p/issues). Search the closed ones before reporting things, and help us with the open ones.
|
||||
|
|
|
|||
Loading…
Reference in New Issue