From 973a00e1308d57da85b0b8ae4bef1112b1e50f1c Mon Sep 17 00:00:00 2001 From: pacrob <5199899+pacrob@users.noreply.github.com> Date: Sat, 2 Mar 2024 13:45:19 -0700 Subject: [PATCH] clean up some README errors --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d343c7d6..2a701c97 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # py-libp2p [![Join the chat at https://gitter.im/py-libp2p/Lobby](https://badges.gitter.im/py-libp2p/Lobby.png)](https://gitter.im/py-libp2p/Lobby) -[![Build Status](https://travis-ci.com/libp2p/py-libp2p.svg?branch=master)](https://travis-ci.com/libp2p/py-libp2p) +[![Build Status](https://circleci.com/gh/ethereum/py-libp2p.svg?style=shield)](https://circleci.com/gh/ethereum/py-libp2p) [![PyPI version](https://badge.fury.io/py/libp2p.svg)](https://badge.fury.io/py/libp2p) [![Python versions](https://img.shields.io/pypi/pyversions/libp2p.svg)](https://pypi.python.org/pypi/libp2p) [![Docs build](https://readthedocs.org/projects/py-libp2p/badge/?version=latest)](http://py-libp2p.readthedocs.io/en/latest/?badge=latest) @@ -10,13 +10,13 @@ [![Discord](https://img.shields.io/discord/475789330380488707?color=blueviolet&label=discord)](https://discord.gg/66KBrm2)

-py-libp2p hex logo + py-libp2p hex logo

## WARNING py-libp2p is an experimental and work-in-progress repo under development. We do not yet recommend using py-libp2p in production environments. -Right now, `tests_interop` are turned off for CI, and a number of `tests` are failing. +Right now, `tests_interop` are turned off for CI, and a number of `tests` are failing. WIP. The Python implementation of the libp2p networking stack @@ -44,23 +44,23 @@ cd py-libp2p virtualenv -p python venv . venv/bin/activate python -m pip install -e .[dev] +pre-commit install ``` +We use [pre-commit](https://pre-commit.com/) to maintain consistent code style. Once +installed, it will run automatically with every commit. You can also run it manually +with `make lint`. If you need to make a commit that skips the `pre-commit` checks, you +can do so with `git commit --no-verify`. + Note that tests/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. ### Release setup -\<\<\<\<\<\<\< HEAD Releases follow the same basic pattern as releases of some tangentially-related projects, like Trinity. See [Trinity's release instructions](https://trinity-client.readthedocs.io/en/latest/contributing.html#releasing). ## Requirements -\======= -To release a new version: - -> > > > > > > template - The protobuf description in this repository was generated by `protoc` at version `25.3`. ## Feature Breakdown