Skip to content

docs: Update README.md #25355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 19, 2025
+52 −20
Merged

docs: Update README.md #25355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
02859e5
docs: Update README.md
merkletreeibc Sep 19, 2025
6e5c822
Update README.md
merkletreeibc Sep 19, 2025
435b4b6
banner
aljo242 Sep 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 31 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<div align="center">
<div align="left">
<h1> Cosmos SDK </h1>
</div>

![banner](docs/static/img/banner.jpg)
![banner](docs/static/img/banner.svg)

<div align="center">
<a href="https://github.com/cosmos/cosmos-sdk/blob/main/LICENSE">
Expand All @@ -22,45 +22,57 @@
<a href="https://sourcegraph.com/github.com/cosmos/cosmos-sdk?badge">
<img alt="Imported by" src="https://sourcegraph.com/github.com/cosmos/cosmos-sdk/-/badge.svg" />
</a>
<a href="https://github.com/cosmos/cosmos-sdk/actions/workflows/sims.yml">
<img alt="Sims" src="https://github.com/cosmos/cosmos-sdk/workflows/Sims/badge.svg" />
</a>
<a href="https://github.com/cosmos/cosmos-sdk/actions/workflows/lint.yml">
<img alt="Lint Status" src="https://github.com/cosmos/cosmos-sdk/workflows/Lint/badge.svg" />
</a>
</div>

The Cosmos SDK is a framework for building blockchain applications. [CometBFT (BFT Consensus)](https://github.com/cometbft/cometbft) and the Cosmos SDK are written in the Go programming language. Cosmos SDK is used to build [Gaia](https://github.com/cosmos/gaia), the implementation of the Cosmos Hub.
The Cosmos SDK is a modular, open-source blockchain SDK for building secure, high-performance Layer 1 chains with full customizability used by 200+ chains in production. Developers can use the Cosmos SDK to easily and quickly spin up custom blockchains that can natively interoperate.

**WARNING**: The Cosmos SDK has mostly stabilized, but we are still making some breaking changes.
The Cosmos SDK is tailored for building secure, sovereign application-specific blockchains. Developers building with the Cosmos SDK can use predefined modules that cover standard blockchain functionality or create custom modules for their specific use case. This composable architecture enables robust customization. The SDK provides abstractions for permissioning, governance, state management, account abstraction, tokenization processes, application logic, and more.

Cosmos SDK blockchains get interoperability out-of-the-box via a native integration with the [Inter-Blockchain Communication Protocol (IBC)](https://github.com/cosmos/ibc-go). Ibc-go is implemented as a Go module in the Cosmos SDK.

While the Cosmos SDK is plug-and-play with any consensus engine, we recommend using [CometBFT](https://github.com/cometbft/cometbft) for a fast, battle-tested, high-throughput, configurable BFT state machine. CometBFT is developed as part of the Cosmos Stack and its releases are updated alongside the SDK.

**Note**: We advise to always use the latest maintained [Go](https://go.dev/dl) version for building Cosmos SDK applications.
**WARNING**: The Cosmos SDK has mostly stabilized, but we are still making some breaking changes.

## Quick Start

To learn how the Cosmos SDK works from a high-level perspective, see the Cosmos SDK [High-Level Intro](https://docs.cosmos.network/main/intro/overview).

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](https://docs.cosmos.network).
Note: We advise to always use the latest maintained [Go version](https://go.dev/dl/) for building Cosmos SDK applications.

## Modules

The Cosmos SDK maintains a set of modules that can be included in your blockchain application. For more information
on modules, see our [introduction doc](./x/README.md).

## Tools and Frameworks
## Maintainers
[Cosmos Labs](https://cosmoslabs.io/) maintains the core components of the stack: Cosmos SDK, CometBFT, IBC, Cosmos EVM, and various developer tools and frameworks. In addition to developing and maintaining the Cosmos Stack, Cosmos Labs provides advisory and engineering services for blockchain solutions. [Get in touch with Cosmos Labs](https://www.cosmoslabs.io/contact).

Cosmos Labs is a wholly-owned subsidiary of the [Interchain Foundation](https://interchain.io/), the Swiss nonprofit responsible for treasury management, funding public goods, and supporting governance for Cosmos.

The Cosmos Stack is supported by a robust community of open-source contributors.

## History
The Cosmos SDK was first released in 2019, and the first blockchain to use the SDK in production was the [Cosmos Hub](https://hub.cosmos.network/main). Today, the Cosmos SDK is a popular, battle-tested, open-source framework used by hundreds of chains.

The Cosmos Hub still receives the most up-to-date Cosmos SDK versions. The Cosmos Hub application, `gaia`, has its own [cosmos/gaia repository](https://github.com/cosmos/gaia).

## Developer Community and Support

The Cosmos ecosystem is vast.
[Awesome Cosmos](https://github.com/cosmos/awesome-cosmos) is a community-curated list of notable frameworks, modules and tools.
The issue list of this repo is exclusively for bug reports and feature requests. We have active, helpful communities on Discord, Telegram, and Slack.

### Cosmos Hub Mainnet
**| Need Help? | Support & Community: [Discord](https://discord.com/invite/interchain) - [Telegram](https://t.me/CosmosOG) - [Talk to an Expert](https://cosmos.network/interest-form) - [Join the #Cosmos-tech Slack Channel](https://forms.gle/A8jawLgB8zuL1FN36) |**

The Cosmos Hub application, `gaia`, has its own [cosmos/gaia repository](https://github.com/cosmos/gaia). Go there to join the Cosmos Hub mainnet and more.
## Documentation and Resources
**View the Cosmos SDK documentation: https://docs.cosmos.network/**

### Inter-Blockchain Communication (IBC)
### Cosmos Stack Libraries

The IBC module for the Cosmos SDK has its own [cosmos/ibc-go repository](https://github.com/cosmos/ibc-go). Go there to build and integrate with the IBC module.
- [CometBFT](https://github.com/cometbft/cometbft) - High-performance, 10k+ TPS configurable BFT consensus engine.
- [The Inter-Blockchain Communication Protocol (IBC)](https://github.com/cosmos/ibc-go/) - A blockchain interoperability protocol that allows blockchains to transfer any type of data encoded in bytes.
- [Cosmos EVM](https://github.com/cosmos/evm) - Native EVM layer for Cosmos SDK chains.

## Disambiguation

Expand Down
2 changes: 1 addition & 1 deletion docs/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ const config = {
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
image: "img/banner.jpg",
image: "img/banner.svg",
Copy link
Contributor

@coderabbitai coderabbitai bot Sep 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

🧩 Analysis chain

Fix: themeConfig.image cannot be an SVG (breaks OG/Twitter cards).

Docusaurus explicitly forbids SVGs for themeConfig.image. Use a raster (PNG/JPG, e.g., 1200x630). Otherwise social previews will fail. (docusaurus.io)

Apply:

-      image: "img/banner.svg",
+      image: "img/banner.png",

Ensure docs/static/img/banner.png exists and matches the hero art.

🏁 Script executed:

#!/bin/bash
# Verify social card asset + repo-wide consistency
set -euo pipefail
echo "Checking Docusaurus meta image usage:"
rg -nP 'themeConfig:\s*\([\s\S]*?image:\s*["\']img/.*\.(svg|png|jpe?g|webp)["\']' docs/docusaurus.config.js -n

echo -e "\nListing banner assets under docs/static/img:"
fd -a -e png -e jpg -e jpeg -e webp -e svg banner docs/static/img || true

echo -e "\nSearching for lingering references to banner.jpg/svg across repo:"
rg -n 'banner\.(svg|jpg|png|jpeg|webp)'

Length of output: 99

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "1) Show docs/docusaurus.config.js (up to 400 lines):"
if [ -f docs/docusaurus.config.js ]; then
  sed -n '1,400p' docs/docusaurus.config.js || true
else
  echo "docs/docusaurus.config.js not found"
fi

echo -e "\n2) Find 'themeConfig' occurrences (context +-3 lines):"
rg -n --hidden -S "themeConfig" -C3 || true

echo -e "\n3) Show lines containing 'image' or 'img/' in docs/docusaurus.config.js:"
if [ -f docs/docusaurus.config.js ]; then
  rg -n --hidden -S "image" docs/docusaurus.config.js -C2 || true
  rg -n --hidden -S "img/" docs/docusaurus.config.js -C2 || true
fi

echo -e "\n4) List image files under docs/static/img (all common image extensions):"
if [ -d docs/static/img ]; then
  fd -a -t f -e svg -e png -e jpg -e jpeg -e webp docs/static/img || true
else
  echo "docs/static/img not found"
fi

echo -e "\n5) Search repo for 'banner.' occurrences (case-insensitive):"
rg -n --hidden -i "banner\\." || true

Length of output: 15894

Replace OG image SVG with a raster and add the asset

  • Change in docs/docusaurus.config.js:65:
-      image: "img/banner.svg",
+      image: "img/banner.png",
  • Add docs/static/img/banner.png (recommended 1200×630) or update the config to point to an existing PNG/JPG. README.md:5 references docs/static/img/banner.svg — update that reference if you replace/move the asset.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
image: "img/banner.svg",
image: "img/banner.png",
🤖 Prompt for AI Agents 
In docs/docusaurus.config.js around line 65, the OG image currently points to an
SVG (img/banner.svg); replace it with a raster image by adding
docs/static/img/banner.png (recommended 1200×630) and update the config line to
"img/banner.png" or alternatively point the config to an existing PNG/JPG; also
update README.md line 5 which references docs/static/img/banner.svg to the new
PNG path so references stay consistent.

docs: {
sidebar: {
autoCollapseCategories: true,
Expand Down
Binary file removed docs/static/img/banner.jpg
View file
Open in desktop
Binary file not shown.
20 changes: 20 additions & 0 deletions docs/static/img/banner.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading