From 579eea155b9e95e21d360a9ce3f1b6a7da3bdf64 Mon Sep 17 00:00:00 2001 From: Ranadeep Biswas Date: Thu, 17 Oct 2024 22:29:33 +0200 Subject: [PATCH] fix readme --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 16cc329..c648b74 100644 --- a/README.md +++ b/README.md @@ -9,21 +9,24 @@ contracts. Currently, the available packages are: ## IBC Clients - [ibc-client-cw](./ibc-clients/cw-context): Provides utilities and a generic - `Context` object to streamline the implementation of any ibc-rs-powered light - clients as CosmWasm contracts. + `Context` object to streamline the implementation of any `ibc-rs` powered + light clients as CosmWasm contracts. - To utilize the CosmWasm contracts developed with this library, hosting environments must support the CosmWasm module and be using the version of `ibc-go` that supports the `08-wasm` proxy light client. -> [!CAUTION] The `ibc-client-cw` is currently in development and should not be -> deployed for production use. Users are advised to exercise caution and test - thoroughly in non-production environments. +> [!CAUTION] +> The `ibc-client-cw` is currently in development and should not be deployed for +> production use. Users are advised to exercise caution and test thoroughly in +> non-production environments. - [ibc-client-tendermint-cw](./ibc-clients/ics07-tendermint): CosmWasm Contract -> [!TIP] The pre-compiled CosmWasm contract for `ibc-client-tendermint-cw` is -> available as a Github workflow artifact at -> [_Actions_](https://github.com/informalsystems/cosmwasm-ibc/actions/workflows/upload-cw-clients.yaml) -> tab. They can be downloaded [during a Github -> workflow](https://github.com/informalsystems/cosmwasm-ibc/blob/d0d137a6a21596b0da73eb77e4acbf0d32d2a79c/.github/workflows/upload-cw-clients.yaml#L65-L72) -> using `actions/download-artifact@v4` action. +> [!TIP] +> The pre-compiled CosmWasm contract for `ibc-client-tendermint-cw` is available +> as a GitHub workflow artifact at [_Actions_][cw-compile-ci] tab. They can be +> downloaded [during a Github workflow][download-artifact-example] using +> `actions/download-artifact@v4` action. + +[cw-compile-ci]: https://github.com/informalsystems/cosmwasm-ibc/actions/workflows/upload-cw-clients.yaml +[download-artifact-example]: https://github.com/informalsystems/cosmwasm-ibc/blob/d0d137a6a21596b0da73eb77e4acbf0d32d2a79c/.github/workflows/upload-cw-clients.yaml#L65-L72