cosmos-sdk/README.md

37 lines
2.3 KiB
Markdown
Raw Normal View History

2018-04-02 10:21:34 -07:00
# Cosmos SDK
![banner](docs/cosmos-sdk-image.jpg)
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)
[![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.
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-05-15 08:17:20 -07:00
**Note**: Requires [Go 1.12+](https://golang.org/dl/)
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
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)
2018-04-13 02:47:46 -07:00
## 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.
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.