Skip to content

Commit

Permalink
docs: added a link to the tutorial in README.md (#70)
Browse files Browse the repository at this point in the history
* docs: added tutorial to README.md

* docs: added more info
  • Loading branch information
srdtrk authored May 27, 2024
1 parent 7bfd9bf commit 1ba48e4
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,16 @@ The quickest way to generate Go code for your CosmWasm smart contracts. Currentl
- A gRPC query client
- An [`interchaintest`](https://github.com/strangelove-ventures/interchaintest) based test suite

**You can find a tutorial on how to use this tool's interchaintest feature [here](https://srdtrk.github.io/go-codegen/).**

## Usage

In order to generate Go code for your CosmWasm smart contract, you need to have its full API exported as a JSON file
using [`cosmwasm-schema`](https://crates.io/crates/cosmwasm-schema).
Once you have the JSON file, you can use it to generate the Go code.

Note that you can learn more about how to use this tool by running `go-codegen help` or `-h` flag with any command.

### Generate messages

```sh
Expand Down Expand Up @@ -64,6 +68,8 @@ go-codegen interchaintest add-contract /path/to/contract-api.json --suite-dir /p

This will add a contract to the test suite. The suite directory is the directory where the test suite is located. If not specified, it will use the current directory. The contract API JSON file is the same file that was used to generate the messages and query client.

Note that you can find a tutorial on how to use this tool's interchaintest feature [here](https://srdtrk.github.io/go-codegen/).

## Acknowledgements

The Go Gopher mascot was created by [Renee French](https://reneefrench.blogspot.com/) and is licensed under the [Creative Commons 4.0 Attribution License](https://creativecommons.org/licenses/by/4.0/).
Expand Down

0 comments on commit 1ba48e4

Please sign in to comment.