Skip to content

Commit 4e54df5

Browse files
mergify[bot]nooomskijulienrbrt
authored
docs: Update mentions of Starport to Ignite CLI (backport #11612) (#11616)
* docs: update mentions of starport to ignite cli (#11612) (cherry picked from commit 06c5d2b) # Conflicts: # README.md # docs/README.md * fix conflicts Co-authored-by: Noam <81436914+nooomski@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr>
1 parent 0478825 commit 4e54df5

File tree

2 files changed

+87
-76
lines changed

2 files changed

+87
-76
lines changed

README.md

Lines changed: 84 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,84 @@
1-
<!--
2-
parent:
3-
order: false
4-
-->
5-
6-
<div align="center">
7-
<h1> Cosmos SDK </h1>
8-
</div>
9-
10-
![banner](docs/cosmos-sdk-image.jpg)
11-
12-
<div align="center">
13-
<a href="https://github.com/cosmos/cosmos-sdk/releases/latest">
14-
<img alt="Version" src="https://img.shields.io/github/tag/cosmos/cosmos-sdk.svg" />
15-
</a>
16-
<a href="https://github.com/cosmos/cosmos-sdk/blob/master/LICENSE">
17-
<img alt="License: Apache-2.0" src="https://img.shields.io/github/license/cosmos/cosmos-sdk.svg" />
18-
</a>
19-
<a href="https://pkg.go.dev/github.com/cosmos/cosmos-sdk?tab=doc">
20-
<img alt="GoDoc" src="https://godoc.org/github.com/cosmos/cosmos-sdk?status.svg" />
21-
</a>
22-
<a href="https://goreportcard.com/report/github.com/cosmos/cosmos-sdk">
23-
<img alt="Go report card" src="https://goreportcard.com/badge/github.com/cosmos/cosmos-sdk" />
24-
</a>
25-
<a href="https://codecov.io/gh/cosmos/cosmos-sdk">
26-
<img alt="Code Coverage" src="https://codecov.io/gh/cosmos/cosmos-sdk/branch/master/graph/badge.svg" />
27-
</a>
28-
</div>
29-
<div align="center">
30-
<a href="https://github.com/cosmos/cosmos-sdk">
31-
<img alt="Lines Of Code" src="https://tokei.rs/b1/github/cosmos/cosmos-sdk" />
32-
</a>
33-
<a href="https://discord.gg/AzefAFd">
34-
<img alt="Discord" src="https://img.shields.io/discord/669268347736686612.svg" />
35-
</a>
36-
<a href="https://sourcegraph.com/github.com/cosmos/cosmos-sdk?badge">
37-
<img alt="Imported by" src="https://sourcegraph.com/github.com/cosmos/cosmos-sdk/-/badge.svg" />
38-
</a>
39-
<img alt="Sims" src="https://github.com/cosmos/cosmos-sdk/workflows/Sims/badge.svg" />
40-
<img alt="Lint Satus" src="https://github.com/cosmos/cosmos-sdk/workflows/Lint/badge.svg" />
41-
</div>
42-
43-
The Cosmos-SDK is a framework for building blockchain applications in Golang.
44-
It is being used to build [`Gaia`](https://github.com/cosmos/gaia), the first implementation of the Cosmos Hub.
45-
46-
**WARNING**: The SDK has mostly stabilized, but we are still making some
47-
breaking changes.
48-
49-
**Note**: Requires [Go 1.15+](https://golang.org/dl/)
50-
51-
## Quick Start
52-
53-
To learn how the SDK works from a high-level perspective, go to the [SDK Intro](./docs/intro/overview.md).
54-
55-
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.
56-
57-
For more, please go to the [Cosmos SDK Docs](./docs/).
58-
59-
## Cosmos Hub Mainnet
60-
61-
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.
62-
63-
## Interblockchain Communication (IBC)
64-
65-
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.
66-
67-
## Starport
68-
69-
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.
70-
71-
## Disambiguation
72-
73-
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.
1+
<!--
2+
parent:
3+
order: false
4+
-->
5+
6+
<div align="center">
7+
<h1> Cosmos SDK </h1>
8+
</div>
9+
10+
![banner](docs/cosmos-sdk-image.jpg)
11+
12+
<div align="center">
13+
<a href="https://github.com/cosmos/cosmos-sdk/releases/latest">
14+
<img alt="Version" src="https://img.shields.io/github/tag/cosmos/cosmos-sdk.svg" />
15+
</a>
16+
<a href="https://github.com/cosmos/cosmos-sdk/blob/master/LICENSE">
17+
<img alt="License: Apache-2.0" src="https://img.shields.io/github/license/cosmos/cosmos-sdk.svg" />
18+
</a>
19+
<a href="https://pkg.go.dev/github.com/cosmos/cosmos-sdk?tab=doc">
20+
<img alt="GoDoc" src="https://godoc.org/github.com/cosmos/cosmos-sdk?status.svg" />
21+
</a>
22+
<a href="https://goreportcard.com/report/github.com/cosmos/cosmos-sdk">
23+
<img alt="Go report card" src="https://goreportcard.com/badge/github.com/cosmos/cosmos-sdk" />
24+
</a>
25+
<a href="https://codecov.io/gh/cosmos/cosmos-sdk">
26+
<img alt="Code Coverage" src="https://codecov.io/gh/cosmos/cosmos-sdk/branch/master/graph/badge.svg" />
27+
</a>
28+
</div>
29+
<div align="center">
30+
<a href="https://github.com/cosmos/cosmos-sdk">
31+
<img alt="Lines Of Code" src="https://tokei.rs/b1/github/cosmos/cosmos-sdk" />
32+
</a>
33+
<a href="https://discord.gg/AzefAFd">
34+
<img alt="Discord" src="https://img.shields.io/discord/669268347736686612.svg" />
35+
</a>
36+
<a href="https://sourcegraph.com/github.com/cosmos/cosmos-sdk?badge">
37+
<img alt="Imported by" src="https://sourcegraph.com/github.com/cosmos/cosmos-sdk/-/badge.svg" />
38+
</a>
39+
<img alt="Sims" src="https://github.com/cosmos/cosmos-sdk/workflows/Sims/badge.svg" />
40+
<img alt="Lint Satus" src="https://github.com/cosmos/cosmos-sdk/workflows/Lint/badge.svg" />
41+
</div>
42+
43+
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.
44+
45+
**WARNING**: The Cosmos SDK has mostly stabilized, but we are still making some
46+
breaking changes.
47+
48+
**Note**: Requires [Go 1.17+](https://golang.org/dl/)
49+
50+
## Quick Start
51+
52+
To learn how the Cosmos SDK works from a high-level perspective, see the Cosmos SDK [High-Level Intro](./docs/intro/overview.md).
53+
54+
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.
55+
56+
For more information, see the [Cosmos SDK Documentation](./docs/).
57+
58+
## Contributing
59+
60+
See [CONTRIBUTING.md](./CONTRIBUTING.md) for details how to contribute and participate in our [dev calls](./CONTRIBUTING.md#teams-dev-calls).
61+
If you want to follow the updates or learn more about the latest design then join our [Discord](https://discord.com/invite/cosmosnetwork).
62+
63+
## Tools and Frameworks
64+
65+
The Cosmos ecosystem is vast. We will only make a few notable mentions here.
66+
67+
+ [Tools](https://v1.cosmos.network/tools): notable frameworks and modules.
68+
+ [CosmJS](https://github.com/cosmos/cosmjs): the Swiss Army knife to power JavaScript based client solutions.
69+
70+
### Cosmos Hub Mainnet
71+
72+
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.
73+
74+
### Inter-Blockchain Communication (IBC)
75+
76+
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.
77+
78+
### Ignite CLI
79+
80+
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.
81+
82+
## Disambiguation
83+
84+
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.

docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ aside: false
4747

4848
## Get Started
4949

50-
- **[SDK Intro](./intro/overview.md)**: High-level overview of the Cosmos SDK.
51-
- **[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.
52-
- **[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.
50+
- **[Cosmos SDK Intro](./intro/overview.md)**: High-level overview of the Cosmos SDK.
51+
- **[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.
52+
- **[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.
5353

5454
## Reference
5555

0 commit comments

Comments
 (0)