History

Tiny熊 3968f63099 Merge PR #4430 : update "intro docs" cn translation to 05/27		2019-05-29 08:57:23 -04:00
..
.vuepress	Merge PR #4388 : Remove gaia docs from sdk repo	2019-05-21 14:16:55 -04:00
_attic	Merge PR #4064 : Remove dep/vendor from documentation and version cmd	2019-04-08 11:00:17 -04:00
architecture	Merge PR #3338 : Remove unused code and examples	2019-01-24 11:18:45 +01:00
clients	Merge PR #4312 : Touch up light client docs	2019-05-27 14:03:06 -07:00
concepts	Merge PR #3119 : Move all store keys into constants	2018-12-19 20:58:30 +01:00
intro	Merge PR #4424 : Update README.md	2019-05-28 10:37:29 -04:00
modules	Merge PR #4353 : Documentation Fixes	2019-05-17 09:24:24 -04:00
spec	Merge PR #4404 : Update Spec to include params	2019-05-24 12:18:07 -04:00
translations	Merge PR #4430 : update "intro docs" cn translation to 05/27	2019-05-29 08:57:23 -04:00
DOCS_README.md	Merge PR #3996 : Update DOCS_README	2019-03-28 12:39:21 -04:00
README.md	Merge PR #4388 : Remove gaia docs from sdk repo	2019-05-21 14:16:55 -04: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.

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.

Cosmos Hub

The Cosmos Hub (gaia) docs have moved here.

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: