2018-04-02 10:21:34 -07:00
# Cosmos SDK
2018-11-14 12:01:59 -08:00
![banner ](docs/cosmos-sdk-image.png )
2018-04-02 10:21:34 -07:00
[![version ](https://img.shields.io/github/tag/cosmos/cosmos-sdk.svg )](https://github.com/cosmos/cosmos-sdk/releases/latest)
2018-07-10 17:34:39 -07:00
[![CircleCI ](https://circleci.com/gh/cosmos/cosmos-sdk/tree/master.svg?style=shield )](https://circleci.com/gh/cosmos/cosmos-sdk/tree/master)
2019-02-03 16:34:49 -08:00
[![Snap Status ](https://build.snapcraft.io/badge/cosmos/cosmos-sdk.svg )](https://build.snapcraft.io/user/cosmos/cosmos-sdk)
2018-07-10 17:34:39 -07:00
[![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)
2018-04-02 10:21:34 -07:00
[![API Reference](https://godoc.org/github.com/cosmos/cosmos-sdk?status.svg
)](https://godoc.org/github.com/cosmos/cosmos-sdk)
2018-06-16 23:01:22 -07:00
[![riot.im ](https://img.shields.io/badge/riot.im-JOIN%20CHAT-green.svg )](https://riot.im/app/#/room/#cosmos-sdk:matrix.org)
2018-04-02 10:21:34 -07:00
2018-06-16 19:23:06 -07:00
The Cosmos-SDK is a framework for building blockchain applications in Golang.
2018-11-15 11:54:54 -08:00
It is being used to build `Gaia` , the first implementation of the Cosmos Hub.
2018-06-16 19:23:06 -07:00
**WARNING**: The SDK has mostly stabilized, but we are still making some
breaking changes.
2018-04-02 10:21:34 -07:00
2019-03-18 05:45:25 -07:00
**Note**: Requires [Go 1.12.1+ ](https://golang.org/dl/ )
2018-04-02 10:21:34 -07:00
2019-03-13 07:09:39 -07:00
## Cosmos Hub Mainnet
2018-06-11 11:35:12 -07:00
2019-03-13 07:09:39 -07:00
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 ).
2018-06-11 11:35:12 -07:00
2019-03-13 07:09:39 -07:00
For status updates and genesis file, see the
[launch repo ](https://github.com/cosmos/launch ).
2018-06-11 11:35:12 -07:00
2018-04-02 10:21:34 -07:00
2018-06-16 19:23:06 -07:00
## Quick Start
2018-04-02 10:21:34 -07:00
2018-11-14 11:44:17 -08:00
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.
2018-07-25 22:10:22 -07:00
2018-11-14 11:44:17 -08:00
For more, please go to the [Cosmos SDK Docs ](./docs/README.md )
2018-04-13 02:47:46 -07:00
## 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.