From 5ebeeecf813d8a644baecbed525bf53efa7abde3 Mon Sep 17 00:00:00 2001 From: Denis Fadeev Date: Wed, 29 Sep 2021 14:24:30 +0500 Subject: [PATCH] docs: Version compatibility table --- readme.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index c817b5da26..130b99e85b 100644 --- a/readme.md +++ b/readme.md @@ -19,7 +19,7 @@ starport chain serve ## Documentation -To learn how to use Starport, check out the [Starport Documentation](https://docs.starport.network). To learn more about how to customize your blockchain see `config.yml` [reference](https://docs.starport.network/kb/config.html). To install Starport locally on GNU/Linux or macOS, follow [these steps](https://docs.starport.network/guide/install.html). +To learn how to use Starport, check out the [Starport Documentation](https://docs.starport.network). To learn more about how to build blockchain apps with Starport, see the [developer guide](https://docs.starport.network/guide/). To install Starport locally on GNU/Linux or macOS, follow [these steps](https://docs.starport.network/guide/install.html). To learn more about building a JavaScript frontend for your Cosmos SDK blockchain, see [`tendermint/vue`](https://github.com/tendermint/vue). @@ -27,6 +27,17 @@ To learn more about building a JavaScript frontend for your Cosmos SDK blockchai For questions and support please join the `cosmos-sdk-starport` channel in the [Cosmos Community Discord](https://discord.com/invite/W8trcGV). The issue list of this repo is exclusively for bug reports and feature requests. +## Cosmos SDK Compatibility + +Blockchains created with Starport use the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/) framework. To ensure the best possible experience, use the version of Starport that corresponds to the version of Cosmos SDK that you blockchain is built with. Unless noted otherwise, a row refers to a minor version and all associated patch versions. + +| Starport | Cosmos SDK | Notes | +| -------- | ---------- | ------------------------------------------------ | +| v0.18 | v0.44 | | +| v0.17 | v0.42 | `starport chain serve` works with v0.44.x chains | + +To upgrade your blockchain to the newer version of Cosmos SDK refer to the [migration guide](https://docs.starport.network/migration/). + ## Contributing We welcome contributions from everyone. The `develop` branch contains the development version of the code. You can branch of from `develop` and create a pull request, or maintain your own fork and submit a cross-repository pull request. If you're not sure where to start check out [contributing.md](contributing.md) for our guidelines & policies for how we develop Starport. Thank you to all those who have contributed to Starport!