From 1240f5f80d0f5500010f170c5c4312325710c970 Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Wed, 13 Apr 2022 10:19:11 +0200 Subject: [PATCH] docs: Update mentions of Starport to Ignite CLI (backport #11612) (#11617) --- README.md | 157 ++++++++++++++++++++++++++----------------------- docs/README.md | 6 +- 2 files changed, 87 insertions(+), 76 deletions(-) diff --git a/README.md b/README.md index f9f6bedc51e2..43ccc56cc255 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,84 @@ - - -
-

Cosmos SDK

-
- -![banner](docs/cosmos-sdk-image.jpg) - -
- - Version - - - License: Apache-2.0 - - - GoDoc - - - Go report card - - - Code Coverage - -
-
- - Lines Of Code - - - Discord - - - Imported by - - Sims - Lint Satus -
- -The Cosmos-SDK is a framework for building blockchain applications in Golang. -It is being used to build [`Gaia`](https://github.com/cosmos/gaia), the first implementation of the Cosmos Hub. - -**WARNING**: The SDK has mostly stabilized, but we are still making some -breaking changes. - -**Note**: Requires [Go 1.15+](https://golang.org/dl/) - -## Quick Start - -To learn how the SDK works from a high-level perspective, go to the [SDK Intro](./docs/intro/overview.md). - -If you want to get started quickly and learn how to build on top of the SDK, please follow the [SDK Application Tutorial](https://tutorials.cosmos.network/nameservice/tutorial/00-intro.html). You can also fork the tutorial's repository to get started building your own Cosmos SDK application. - -For more, please go to the [Cosmos SDK Docs](./docs/). - -## Cosmos Hub Mainnet - -The Cosmos Hub application, `gaia`, has moved to its [own repository](https://github.com/cosmos/gaia). Go there to join the Cosmos Hub mainnet and more. - -## Interblockchain Communication (IBC) - -The IBC module for the SDK has moved to its [own repository](https://github.com/cosmos/ibc-go). Go there to build and integrate with the IBC module. - -## Starport - -If you are starting a new app or a new module you can use [Starport](https://github.com/tendermint/starport) to help you get started and speed up development. If you have any questions or find a bug, feel free to open an issue in the repo. - -## Disambiguation - -This Cosmos-SDK project is not related to the [React-Cosmos](https://github.com/react-cosmos/react-cosmos) project (yet). Many thanks to Evan Coury and Ovidiu (@skidding) for this Github organization name. As per our agreement, this disambiguation notice will stay here. + + +
+

Cosmos SDK

+
+ +![banner](docs/cosmos-sdk-image.jpg) + +
+ + Version + + + License: Apache-2.0 + + + GoDoc + + + Go report card + + + Code Coverage + +
+
+ + Lines Of Code + + + Discord + + + Imported by + + Sims + Lint Satus +
+ +The Cosmos SDK is a framework for building blockchain applications. [Tendermint Core (BFT Consensus)](https://github.com/tendermint/tendermint) and the Cosmos SDK are written in the Golang programming language. Cosmos SDK is used to build [Gaia](https://github.com/cosmos/gaia), the first implementation of the Cosmos Hub. + +**WARNING**: The Cosmos SDK has mostly stabilized, but we are still making some +breaking changes. + +**Note**: Requires [Go 1.17+](https://golang.org/dl/) + +## Quick Start + +To learn how the Cosmos SDK works from a high-level perspective, see the Cosmos SDK [High-Level Intro](./docs/intro/overview.md). + +If you want to get started quickly and learn how to build on top of Cosmos SDK, visit [Cosmos SDK Tutorials](https://tutorials.cosmos.network). You can also fork the tutorial's repository to get started building your own Cosmos SDK application. + +For more information, see the [Cosmos SDK Documentation](./docs/). + +## Contributing + +See [CONTRIBUTING.md](./CONTRIBUTING.md) for details how to contribute and participate in our [dev calls](./CONTRIBUTING.md#teams-dev-calls). +If you want to follow the updates or learn more about the latest design then join our [Discord](https://discord.com/invite/cosmosnetwork). + +## Tools and Frameworks + +The Cosmos ecosystem is vast. We will only make a few notable mentions here. + ++ [Tools](https://v1.cosmos.network/tools): notable frameworks and modules. ++ [CosmJS](https://github.com/cosmos/cosmjs): the Swiss Army knife to power JavaScript based client solutions. + +### Cosmos Hub Mainnet + +The Cosmos Hub application, `gaia`, has moved to its own [cosmos/gaia repository](https://github.com/cosmos/gaia). Go there to join the Cosmos Hub mainnet and more. + +### Inter-Blockchain Communication (IBC) + +The IBC module for the Cosmos SDK has moved to its own [cosmos/ibc-go repository](https://github.com/cosmos/ibc-go). Go there to build and integrate with the IBC module. + +### Ignite CLI + +Ignite CLI is the all-in-one platform to build, launch, and maintain any crypto application on a sovereign and secured blockchain. If you are building a new app or a new module, use [Ignite CLI](https://github.com/ignite-hq/cli) to get started and speed up development. + +## Disambiguation + +This Cosmos SDK project is not related to the [React-Cosmos](https://github.com/react-cosmos/react-cosmos) project (yet). Many thanks to Evan Coury and Ovidiu (@skidding) for this Github organization name. As per our agreement, this disambiguation notice will stay here. diff --git a/docs/README.md b/docs/README.md index d3caf5497404..657a46f7b5a1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -47,9 +47,9 @@ aside: false ## Get Started -- **[SDK Intro](./intro/overview.md)**: High-level overview of the Cosmos SDK. -- **[Starport](https://github.com/tendermint/starport/blob/develop/docs/README.md)**: A developer-friendly interface to the Cosmos SDK to scaffold a standard Cosmos SDK blockchain app. -- **[SDK Application Tutorial](https://github.com/cosmos/sdk-application-tutorial)**: A tutorial that showcases how to build a Cosmos SDK-based blockchain from scratch and explains the basic principles of the SDK in the process. +* **[Cosmos SDK Intro](./intro/overview.md)**: High-level overview of the Cosmos SDK. +* **[Ignite CLI](https://docs.ignite.com)**: A developer-friendly interface to the Cosmos SDK to scaffold, launch, and maintain any crypto application on a sovereign and secured blockchain. +* **[SDK Tutorials](https://tutorials.cosmos.network/)**: Tutorials that showcase how to build Cosmos SDK-based blockchains from scratch and explain the basic Cosmos SDK principles in the process. ## Reference