Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rnbguy committed Oct 17, 2024
1 parent 9613ef2 commit 579eea1
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 579eea1

Please sign in to comment.