History

Alessio Treglia a1ac04c96b add keyring backends docs (#5854 ) In addition to #5822.		2020-03-23 19:02:10 +01:00
..
.vuepress	Merge PR #5464 : Update config.js	2020-01-02 12:31:55 -05:00
architecture	Update docs/architecture/adr-020-protobuf-transaction-encoding.md	2020-03-16 10:48:37 -04:00
basics	Merge PR #5625 : docs: sentence about gas is not correct currently	2020-02-07 10:28:54 -05:00
building-modules	Update module spec (#5751 )	2020-03-05 15:40:25 +00:00
cn	fix chinese sdk tutorials URL (#5590 )	2020-01-30 14:11:05 +01:00
core	Favor marshal unmashal binare bare (#5799 )	2020-03-13 19:58:43 +00:00
interfaces	add keyring backends docs (#5854 )	2020-03-23 19:02:10 +01:00
intro	Merge PR #5654 : Replace Lino with Kava in docs	2020-02-17 15:08:16 +01:00
kr	Merge PR #5379 : New docs V1 (merge master-docs to master)	2019-12-10 09:29:46 -05:00
ru	Merge PR #5379 : New docs V1 (merge master-docs to master)	2019-12-10 09:29:46 -05:00
spec	Merge PR #5463 : docs: add link to iavl documentation	2020-01-02 10:25:09 -05:00
using-the-sdk	Merge PR #5604 : docs: minor doc formatting & touchup of the scaffold section	2020-02-04 13:16:56 -05:00
DOCS_README.md	Merge PR #5379 : New docs V1 (merge master-docs to master)	2019-12-10 09:29:46 -05:00
README.md	Add quick start guide (#5517 )	2020-01-17 18:11:22 +01:00
Screen Shot 2019-10-17 at 15.07.22.png	Merge PR #5379 : New docs V1 (merge master-docs to master)	2019-12-10 09:29:46 -05:00
cosmos-sdk-image.jpg	Merge PR #4643 : Update cosmos sdk image, remove unused images	2019-06-30 16:29:05 -04:00
package-lock.json	Simulation docs (#5033 )	2020-01-31 16:06:05 +01:00
package.json	Simulation docs (#5033 )	2020-01-31 16:06:05 +01:00
post.sh	Final updates for new docs website (#5388 )	2019-12-11 18:35:27 +01:00
pre.sh	Final updates for new docs website (#5388 )	2019-12-11 18:35:27 +01:00
versions	Merge PR #4984 : Switch docs version to master	2019-09-03 12:43:33 -04:00

README.md

Cosmos SDK Documentation

Get Started

SDK Intro: High-level overview of the Cosmos SDK.
Quick Start Guide: Scaffold a standard Cosmos SDK app and run a node.
SDK Application Tutorial: A tutorial that showcases how to build an SDK-based blockchain from scratch and explains the basic principles of the SDK in the process.

Reference

Basics: Documentation on the basic concepts of the Cosmos SDK, like the standard anatomy of an application, the transaction lifecycle and accounts management.
Core: Documentation on the core concepts of the Cosmos SDK, like baseapp, the store or the server.
Building Modules: Important concepts for module developers like messages, keepers, handlers and queriers.
Interfaces: Documentation on building interfaces for Cosmos SDK applications.

Other Resources

Module Directory: Module implementations and their respective documentation.
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

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.