Skip to content

Commit

Permalink
chore: add perf to readme (#271)
Browse files Browse the repository at this point in the history
  • Loading branch information
p-shahi committed Aug 25, 2023
1 parent c39bfb9 commit 20b73dd
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,28 @@
# 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/5960949302/attempts/1#summary-16169216290)

[![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!

## History

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
Expand Down

0 comments on commit 20b73dd

Please sign in to comment.