Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: add perf to readme #271

Merged
merged 3 commits into from
Aug 25, 2023
Merged

chore: add perf to readme #271

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ff145b9
chore: add perf to readme
p-shahi Aug 22, 2023
f0e1dd6
Apply suggestions from code review
p-shahi Aug 25, 2023
e491037
Update README.md
p-shahi Aug 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
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/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!

## 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 [libp2p perf protocol](https://github.com/libp2p/specs/blob/master/perf/perf.md) and the [benchmarking README](./perf#libp2p-performance-benchmarking).
p-shahi marked this conversation as resolved.
Show resolved Hide resolved

## Roadmap

Our roadmap for test-plans can be found here: https://github.com/libp2p/test-plans/blob/master/ROADMAP.md
Expand Down