42 lines
2.5 KiB
Markdown
42 lines
2.5 KiB
Markdown
# Cosmos SDK
|
|
![banner](docs/cosmos-sdk-image.png)
|
|
|
|
[![version](https://img.shields.io/github/tag/cosmos/cosmos-sdk.svg)](https://github.com/cosmos/cosmos-sdk/releases/latest)
|
|
[![CircleCI](https://circleci.com/gh/cosmos/cosmos-sdk/tree/master.svg?style=shield)](https://circleci.com/gh/cosmos/cosmos-sdk/tree/master)
|
|
[![Snap Status](https://build.snapcraft.io/badge/cosmos/cosmos-sdk.svg)](https://build.snapcraft.io/user/cosmos/cosmos-sdk)
|
|
[![codecov](https://codecov.io/gh/cosmos/cosmos-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/cosmos/cosmos-sdk)
|
|
[![Go Report Card](https://goreportcard.com/badge/github.com/cosmos/cosmos-sdk)](https://goreportcard.com/report/github.com/cosmos/cosmos-sdk)
|
|
[![license](https://img.shields.io/github/license/cosmos/cosmos-sdk.svg)](https://github.com/cosmos/cosmos-sdk/blob/master/LICENSE)
|
|
[![LoC](https://tokei.rs/b1/github/cosmos/cosmos-sdk)](https://github.com/cosmos/cosmos-sdk)
|
|
[![API Reference](https://godoc.org/github.com/cosmos/cosmos-sdk?status.svg
|
|
)](https://godoc.org/github.com/cosmos/cosmos-sdk)
|
|
[![riot.im](https://img.shields.io/badge/riot.im-JOIN%20CHAT-green.svg)](https://riot.im/app/#/room/#cosmos-sdk:matrix.org)
|
|
|
|
The Cosmos-SDK is a framework for building blockchain applications in Golang.
|
|
It is being used to build `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.12.1+](https://golang.org/dl/)
|
|
|
|
## Cosmos Hub Mainnet
|
|
|
|
To run a full-node for the mainnet of the Cosmos Hub, first [install `gaia`](./docs/gaia/installation.md), then follow [the guide](./docs/gaia/join-mainnet.md).
|
|
|
|
For status updates and genesis file, see the
|
|
[launch repo](https://github.com/cosmos/launch).
|
|
|
|
|
|
## Quick Start
|
|
|
|
To learn how the SDK works from a high-level perspective, go to the [SDK Intro](./docs/intro/README.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://github.com/cosmos/sdk-application-tutorial). You can also fork the tutorial's repo to get started building your own Cosmos SDK application.
|
|
|
|
For more, please go to the [Cosmos SDK Docs](./docs/README.md)
|
|
|
|
## 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.
|