History

frog power 4000 2ca86c8605 Merge PR #3898 : Circuit breaker high level explanation		2019-03-25 16:37:05 +01:00
..
.vuepress	Merge PR #3838 : Update Docs for mainnet	2019-03-13 07:09:39 -07:00
_attic	Merge PR #3912 : Fix a bunch of typos while skimming through the docs	2019-03-15 18:10:11 +01:00
architecture	Merge PR #3338 : Remove unused code and examples	2019-01-24 11:18:45 +01:00
clients	Remove REST server's secure mode altogether	2019-03-19 18:20:53 +01:00
concepts	Merge PR #3119 : Move all store keys into constants	2018-12-19 20:58:30 +01:00
gaia	Merge PR #3965 : Cherry pick docs update to develop	2019-03-22 13:53:37 -07:00
intro	Merge PR #3847 : Fix typos, and update deprecated links	2019-03-11 18:23:46 +01:00
modules	Rename stake/ to staking/ (#3280 )	2019-01-11 12:08:01 -08:00
spec	Merge PR #3898 : Circuit breaker high level explanation	2019-03-25 16:37:05 +01:00
translations	Merge PR #3955 : update docs chinese translation	2019-03-22 12:06:55 -07:00
DOCS_README.md	Fix swagger (#3232 )	2019-01-08 08:13:04 -08:00
PRIORITIES.md	Merge PR #2642 : Add todo diagrams	2018-10-31 12:07:06 +01:00
README.md	Merge PR #3838 : Update Docs for mainnet	2019-03-13 07:09:39 -07:00
RELEASE_PROCESS.md	Merge PR #3571 : Update RELEASE_PROCESS.md	2019-02-09 04:15:32 +01:00
RELEASE_TEST_SCRIPT.md	update release test script links, closes #2606	2018-12-11 14:40:25 -05:00
cosmos-docs.jpg	Documentation Structure Change and Cleanup (#2808 )	2018-11-14 11:44:17 -08:00
cosmos-sdk-image.png	Bring back banner (#2814 )	2018-11-14 12:01:59 -08:00

README.md

Cosmos SDK Documentation

Get Started

SDK Intro: High-level overview of the Cosmos SDK.
SDK application tutorial: A tutorial to learn the SDK. It showcases how to build an SDK-based blockchain from scratch, and explains the basic principles of the SDK in the process.

Resources

Specifications: Specifications of modules and other parts of the Cosmos SDK.
SDK API Reference: Godocs of the Cosmos SDK.
REST API spec: List of endpoints to interact with a gaia full-node through REST.

Cosmos Hub

Join the mainnet of the Cosmos Hub.
Join the latest public testnet of the Cosmos Hub.
Start your own gaia testnet.

Creating a new SDK project

To create a new project, you can either:

Fork this repo. Do not forget to remove the nameservice module from the various files if you don't need it.
Use community tools like chainkit.

Languages

The Cosmos-SDK is currently written in Golang, though the framework could be implemented similarly in other languages. Contact us for information about funding an implementation in another language.

Contribute

See this file for details of the build process and considerations when making changes.

Version

This documentation is built from the following commit: