diff --git a/README.md b/README.md index 63279721b..30bec1e42 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@ -# Interoperabilty and end to end test-plans for libp2p +# Interoperability/end to end test-plans & performance benchmarking for libp2p [![Interop Dashboard](https://github.com/libp2p/test-plans/workflows/libp2p%20multidimensional%20interop%20test/badge.svg?branch=master)](https://github.com/libp2p/test-plans/actions/runs/5923803354/attempts/1#summary-16060125258) [![Made by Protocol Labs](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai) -This repository contains interoperability and end to end tests for libp2p modules across different implementations and versions. +This repository contains: +* interoperability and end to end tests for libp2p modules across different implementations and versions +* components to run performance benchmarks for different libp2p implementations -## Specs +## Multidimensional Interop +### Specs -Please see our first specification for interoperability tests between transports, multiplexers, and secure channels here: [Interoperability Test Specs](https://github.com/libp2p/test-plans/blob/master/multidim-interop/README.md) +Please see our first specification for interoperability tests between transports, multiplexers, and secure channels here: [Interoperability Test Specs](./multidim-interop/README.md) More specs to come soon! @@ -16,6 +19,10 @@ More specs to come soon! These test-plans historically used Testground. To read why we're now using `docker compose` instead please see: [Why we're moving away from Testground](https://github.com/libp2p/test-plans/issues/103) +## Performance Benchmarking + +Please see the [benchmarking README](./perf#libp2p-performance-benchmarking). + ## Roadmap Our roadmap for test-plans can be found here: https://github.com/libp2p/test-plans/blob/master/ROADMAP.md