From bf159122fb532bf0bfcadfe362ded87239905f0e Mon Sep 17 00:00:00 2001 From: Romain Ruetschi Date: Tue, 24 May 2022 14:18:38 +0200 Subject: [PATCH] Add `ibc-test-framework` to the main README (#2236) * Add `ibc-test-framework` to the main README * Cleanup --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cdfdac0d81..8b90bbc69a 100644 --- a/README.md +++ b/README.md @@ -24,19 +24,21 @@ This project comprises primarily four crates: and its [IBC structs](https://github.com/cosmos/ibc-go/tree/main/proto/ibc). - The [`ibc-telemetry`][ibc-telemetry-crate-link] crate is a library for use in the `hermes` CLI, for gathering telemetry data and exposing that in a Prometheus endpoint. +- The [`ibc-test-framework`][ibc-test-framework-crate-link] crate provides the infrastructure and framework for writing end-to-end (E2E) tests that include the spawning of the relayer together with Cosmos full nodes. See the table below for more details. Includes [TLA+ specifications](docs/spec). -| Crate name | Type | Version | Docs | +| Crate name | Type | Version | Docs | |:-------------:|:------:|:-------------:|:-----:| -| [ibc](./modules) (modules) | lib| [![IBC Crate][ibc-crate-image]][ibc-crate-link] | [![IBC Docs][ibc-docs-image]][ibc-docs-link] | -| [ibc-relayer](./relayer) | lib | [![IBC Relayer Crate][relayer-crate-image]][relayer-crate-link] | [![IBC Relayer Docs][relayer-docs-image]][relayer-docs-link] | -| [ibc-relayer-cli](./relayer-cli) | bin: [hermes](relayer-cli/) | [![IBC Relayer CLI Crate][relayer-cli-crate-image]][relayer-cli-crate-link] | [![IBC Relayer CLI Docs][relayer-cli-docs-image]][relayer-cli-docs-link] | -| [ibc-relayer-rest](./relayer-rest) | lib | [![IBC Relayer REST Crate][relayer-rest-crate-image]][relayer-rest-crate-link] | [![IBC Relayer REST Docs][relayer-rest-docs-image]][relayer-rest-docs-link] | -| [ibc-proto](./proto) | lib | [![IBC Proto Crate][ibc-proto-crate-image]][ibc-proto-crate-link] | [![IBC Proto Docs][ibc-proto-docs-image]][ibc-proto-docs-link] | -| [ibc-telemetry](./telemetry) | lib | [![IBC Telemetry Crate][ibc-telemetry-crate-image]][ibc-telemetry-crate-link] | [![IBC Telemetry Docs][ibc-telemetry-docs-image]][ibc-telemetry-docs-link] | +| [ibc](./modules) | lib | [![IBC Crate][ibc-crate-image]][ibc-crate-link] | [![IBC Docs][ibc-docs-image]][ibc-docs-link] | +| [ibc-relayer](./relayer) | lib | [![IBC Relayer Crate][relayer-crate-image]][relayer-crate-link] | [![IBC Relayer Docs][relayer-docs-image]][relayer-docs-link] | +| [ibc-relayer-cli](./relayer-cli) | bin: [hermes](relayer-cli/) | [![IBC Relayer CLI Crate][relayer-cli-crate-image]][relayer-cli-crate-link] | [![IBC Relayer CLI Docs][relayer-cli-docs-image]][relayer-cli-docs-link] | +| [ibc-relayer-rest](./relayer-rest) | lib | [![IBC Relayer REST Crate][relayer-rest-crate-image]][relayer-rest-crate-link] | [![IBC Relayer REST Docs][relayer-rest-docs-image]][relayer-rest-docs-link] | +| [ibc-proto](./proto) | lib | [![IBC Proto Crate][ibc-proto-crate-image]][ibc-proto-crate-link] | [![IBC Proto Docs][ibc-proto-docs-image]][ibc-proto-docs-link] | +| [ibc-telemetry](./telemetry) | lib | [![IBC Telemetry Crate][ibc-telemetry-crate-image]][ibc-telemetry-crate-link] | [![IBC Telemetry Docs][ibc-telemetry-docs-image]][ibc-telemetry-docs-link] | +| [ibc-test-framework](./tools/test-framework) | lib | [![IBC Test Framework Crate][ibc-test-framework-crate-image]][ibc-test-framework-crate-link] | [![IBC Test Framework Docs][ibc-test-framework-docs-image]][ibc-test-framework-docs-link] | ## Requirements @@ -105,6 +107,10 @@ Unless required by applicable law or agreed to in writing, software distributed [ibc-telemetry-crate-link]: https://crates.io/crates/ibc-telemetry [ibc-telemetry-docs-image]: https://docs.rs/ibc-telemetry/badge.svg [ibc-telemetry-docs-link]: https://docs.rs/ibc-telemetry/ +[ibc-test-framework-crate-image]: https://img.shields.io/crates/v/ibc-test-framework.svg +[ibc-test-framework-crate-link]: https://crates.io/crates/ibc-test-framework +[ibc-test-framework-docs-image]: https://docs.rs/ibc-test-framework/badge.svg +[ibc-test-framework-docs-link]: https://docs.rs/ibc-test-framework/ [build-image]: https://github.com/informalsystems/ibc-rs/workflows/Rust/badge.svg [build-link]: https://github.com/informalsystems/ibc-rs/actions?query=workflow%3ARust