mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2026-02-12 16:10:57 +00:00
Merge pull request #813 from sumanjeet0012/feature/update-readme-status
docs: update README.md with module status and source links.
This commit is contained in:
48
README.md
48
README.md
@ -34,19 +34,19 @@ ______________________________________________________________________
|
|||||||
| -------------------------------------- | :--------: | :---------------------------------------------------------------------------------: |
|
| -------------------------------------- | :--------: | :---------------------------------------------------------------------------------: |
|
||||||
| **`libp2p-tcp`** | ✅ | [source](https://github.com/libp2p/py-libp2p/blob/main/libp2p/transport/tcp/tcp.py) |
|
| **`libp2p-tcp`** | ✅ | [source](https://github.com/libp2p/py-libp2p/blob/main/libp2p/transport/tcp/tcp.py) |
|
||||||
| **`libp2p-quic`** | 🌱 | |
|
| **`libp2p-quic`** | 🌱 | |
|
||||||
| **`libp2p-websocket`** | ❌ | |
|
| **`libp2p-websocket`** | 🌱 | |
|
||||||
| **`libp2p-webrtc-browser-to-server`** | ❌ | |
|
| **`libp2p-webrtc-browser-to-server`** | 🌱 | |
|
||||||
| **`libp2p-webrtc-private-to-private`** | ❌ | |
|
| **`libp2p-webrtc-private-to-private`** | 🌱 | |
|
||||||
|
|
||||||
______________________________________________________________________
|
______________________________________________________________________
|
||||||
|
|
||||||
### NAT Traversal
|
### NAT Traversal
|
||||||
|
|
||||||
| **NAT Traversal** | **Status** |
|
| **NAT Traversal** | **Status** | **Source** |
|
||||||
| ----------------------------- | :--------: |
|
| ----------------------------- | :--------: | :-----------------------------------------------------------------------------: |
|
||||||
| **`libp2p-circuit-relay-v2`** | ❌ |
|
| **`libp2p-circuit-relay-v2`** | ✅ | [source](https://github.com/libp2p/py-libp2p/tree/main/libp2p/relay/circuit_v2) |
|
||||||
| **`libp2p-autonat`** | ❌ |
|
| **`libp2p-autonat`** | ✅ | [source](https://github.com/libp2p/py-libp2p/tree/main/libp2p/host/autonat) |
|
||||||
| **`libp2p-hole-punching`** | ❌ |
|
| **`libp2p-hole-punching`** | ✅ | [source](https://github.com/libp2p/py-libp2p/tree/main/libp2p/relay/circuit_v2) |
|
||||||
|
|
||||||
______________________________________________________________________
|
______________________________________________________________________
|
||||||
|
|
||||||
@ -54,27 +54,27 @@ ______________________________________________________________________
|
|||||||
|
|
||||||
| **Secure Communication** | **Status** | **Source** |
|
| **Secure Communication** | **Status** | **Source** |
|
||||||
| ------------------------ | :--------: | :---------------------------------------------------------------------------: |
|
| ------------------------ | :--------: | :---------------------------------------------------------------------------: |
|
||||||
| **`libp2p-noise`** | 🌱 | [source](https://github.com/libp2p/py-libp2p/tree/main/libp2p/security/noise) |
|
| **`libp2p-noise`** | ✅ | [source](https://github.com/libp2p/py-libp2p/tree/main/libp2p/security/noise) |
|
||||||
| **`libp2p-tls`** | ❌ | |
|
| **`libp2p-tls`** | 🌱 | |
|
||||||
|
|
||||||
______________________________________________________________________
|
______________________________________________________________________
|
||||||
|
|
||||||
### Discovery
|
### Discovery
|
||||||
|
|
||||||
| **Discovery** | **Status** |
|
| **Discovery** | **Status** | **Source** |
|
||||||
| -------------------- | :--------: |
|
| -------------------- | :--------: | :--------------------------------------------------------------------------------: |
|
||||||
| **`bootstrap`** | ❌ |
|
| **`bootstrap`** | ✅ | [source](https://github.com/libp2p/py-libp2p/tree/main/libp2p/discovery/bootstrap) |
|
||||||
| **`random-walk`** | ❌ |
|
| **`random-walk`** | 🌱 | |
|
||||||
| **`mdns-discovery`** | ❌ |
|
| **`mdns-discovery`** | ✅ | [source](https://github.com/libp2p/py-libp2p/tree/main/libp2p/discovery/mdns) |
|
||||||
| **`rendezvous`** | ❌ |
|
| **`rendezvous`** | 🌱 | |
|
||||||
|
|
||||||
______________________________________________________________________
|
______________________________________________________________________
|
||||||
|
|
||||||
### Peer Routing
|
### Peer Routing
|
||||||
|
|
||||||
| **Peer Routing** | **Status** |
|
| **Peer Routing** | **Status** | **Source** |
|
||||||
| -------------------- | :--------: |
|
| -------------------- | :--------: | :--------------------------------------------------------------------: |
|
||||||
| **`libp2p-kad-dht`** | ❌ |
|
| **`libp2p-kad-dht`** | ✅ | [source](https://github.com/libp2p/py-libp2p/tree/main/libp2p/kad_dht) |
|
||||||
|
|
||||||
______________________________________________________________________
|
______________________________________________________________________
|
||||||
|
|
||||||
@ -89,10 +89,10 @@ ______________________________________________________________________
|
|||||||
|
|
||||||
### Stream Muxers
|
### Stream Muxers
|
||||||
|
|
||||||
| **Stream Muxers** | **Status** | **Status** |
|
| **Stream Muxers** | **Status** | **Source** |
|
||||||
| ------------------ | :--------: | :----------------------------------------------------------------------------------------: |
|
| ------------------ | :--------: | :-------------------------------------------------------------------------------: |
|
||||||
| **`libp2p-yamux`** | 🌱 | |
|
| **`libp2p-yamux`** | ✅ | [source](https://github.com/libp2p/py-libp2p/tree/main/libp2p/stream_muxer/yamux) |
|
||||||
| **`libp2p-mplex`** | 🛠️ | [source](https://github.com/libp2p/py-libp2p/blob/main/libp2p/stream_muxer/mplex/mplex.py) |
|
| **`libp2p-mplex`** | ✅ | [source](https://github.com/libp2p/py-libp2p/tree/main/libp2p/stream_muxer/mplex) |
|
||||||
|
|
||||||
______________________________________________________________________
|
______________________________________________________________________
|
||||||
|
|
||||||
@ -100,7 +100,7 @@ ______________________________________________________________________
|
|||||||
|
|
||||||
| **Storage** | **Status** |
|
| **Storage** | **Status** |
|
||||||
| ------------------- | :--------: |
|
| ------------------- | :--------: |
|
||||||
| **`libp2p-record`** | ❌ |
|
| **`libp2p-record`** | 🌱 |
|
||||||
|
|
||||||
______________________________________________________________________
|
______________________________________________________________________
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user