Skip to content

Commit c71d416

Browse files
committed
change Identify section to Core Protocols and add Ping, clean up abit
1 parent 45cdd1a commit c71d416

File tree

1 file changed

+12
-16
lines changed

1 file changed

+12
-16
lines changed

README.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# py-libp2p
22

3+
<h1 align="center">
4+
<a href="https://libp2p.io/"><img width="250" src="https://github.com/libp2p/py-libp2p/blob/main/assets/py-libp2p-logo.png?raw=true" alt="py-libp2p hex logo" /></a>
5+
</h1>
6+
7+
<h3 align="center">The Python implementation of the libp2p networking stack.</h3>
8+
39
[![Join the chat at https://gitter.im/py-libp2p/Lobby](https://badges.gitter.im/py-libp2p/Lobby.png)](https://gitter.im/py-libp2p/Lobby)
410
[![Build Status](https://circleci.com/gh/libp2p/py-libp2p.svg?style=shield)](https://circleci.com/gh/libp2p/py-libp2p)
511
[![PyPI version](https://badge.fury.io/py/libp2p.svg)](https://badge.fury.io/py/libp2p)
@@ -9,25 +15,14 @@
915
[![Matrix](https://img.shields.io/badge/matrix-%23libp2p%3Apermaweb.io-blue.svg)](https://riot.permaweb.io/#/room/#libp2p:permaweb.io)
1016
[![Discord](https://img.shields.io/discord/475789330380488707?color=blueviolet&label=discord)](https://discord.gg/66KBrm2)
1117

12-
<h1 align="center">
13-
<a href="https://libp2p.io/"><img width="250" src="https://github.com/libp2p/py-libp2p/blob/main/assets/py-libp2p-logo.png?raw=true" alt="py-libp2p hex logo" /></a>
14-
</h1>
15-
16-
## WARNING
17-
18-
py-libp2p is an experimental and work-in-progress repo under development. We do not yet recommend using py-libp2p in production environments.
19-
Right now, `tests_interop` are turned off for CI, and a number of `tests` are failing. WIP.
20-
21-
The Python implementation of the libp2p networking stack
18+
> ⚠️ **Warning:** py-libp2p is an experimental and work-in-progress repo under development. We do not yet recommend using py-libp2p in production environments.
2219
2320
Read more in the [documentation on ReadTheDocs](https://py-libp2p.readthedocs.io/). [View the release notes](https://py-libp2p.readthedocs.io/en/latest/release_notes.html).
2421

2522
## Maintainers
2623

2724
Currently maintained by [@pacrob](https://github.com/pacrob) and [@dhuseby](https://github.com/dhuseby), looking for assistance!
2825

29-
Note that tests/core/test_libp2p/test_libp2p.py contains an end-to-end messaging test between two libp2p hosts, which is the bulk of our proof of concept.
30-
3126
## Feature Breakdown
3227

3328
py-libp2p aims for conformity with [the standard libp2p modules](https://github.com/libp2p/libp2p/blob/master/REQUIREMENTS.md#libp2p-modules-implementations). Below is a breakdown of the modules we have developed, are developing, and may develop in the future.
@@ -38,13 +33,15 @@ py-libp2p aims for conformity with [the standard libp2p modules](https://github.
3833
| ------------ | :-----------: |
3934
| **`libp2p`** | :green_apple: |
4035

41-
| Identify Protocol | Status |
42-
| ----------------- | :-----: |
43-
| **`Identify`** | :lemon: |
36+
| Core Protocols | Status |
37+
| -------------- | :-----------: |
38+
| **`Ping`** | :green_apple: |
39+
| **`Identify`** | :green_apple: |
4440

4541
| Transport Protocols | Status |
4642
| ------------------- | :-----------: |
4743
| **`TCP`** | :green_apple: |
44+
| **`QUIC`** | :lemon: |
4845
| **`UDP`** | :tomato: |
4946
| **`WebSockets`** | :chestnut: |
5047
| **`UTP`** | :chestnut: |
@@ -56,7 +53,6 @@ py-libp2p aims for conformity with [the standard libp2p modules](https://github.
5653
| **`Bluetooth LE`** | :chestnut: |
5754
| **`Audio TP`** | :chestnut: |
5855
| **`Zerotier`** | :chestnut: |
59-
| **`QUIC`** | :chestnut: |
6056

6157
| Stream Muxers | Status |
6258
| ---------------- | :-----------: |

0 commit comments

Comments
 (0)