certusone
/
cosmos-sdk
mirror of https://github.com/certusone/cosmos-sdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
cosmos-sdk/docs
History
Zach 5802becf09 Docs configuration changes (#3106) 2018-12-13 10:16:23 -08:00
..
.vuepress Docs configuration changes (#3106) 2018-12-13 10:16:23 -08:00
_attic Run make format 2018-12-10 14:27:25 +00:00
architecture reference to concepts 2018-12-12 14:16:00 +01:00
clients Merge PR #3087: Fix gaia lite docs on REST server's SSL flags 2018-12-12 13:17:15 +01:00
concepts reference to concepts 2018-12-12 14:16:00 +01:00
examples Merge PR #2959: Add TxEncoder to client TxBuilder 2018-12-12 22:29:42 +01:00
gaia merge 2018-12-12 14:17:07 +01:00
intro Fix directory listing in intro (#3097) 2018-12-13 09:55:28 -08:00
modules add links for modules and clients 2018-06-29 01:59:52 -04:00
spec Merge PR #2990: Update f1 spec 2018-12-12 13:13:53 +01:00
DOCS_README.md Update contributing.md with new merge policy (#2789) 2018-11-14 13:12:03 -08:00
PRIORITIES.md Merge PR #2642: Add todo diagrams 2018-10-31 12:07:06 +01:00
README.md reference to concepts 2018-12-12 14:16:00 +01:00
RELEASE_PROCESS.md Suggest opening pending PR back to develop 2018-09-07 01:04:58 +02: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

Welcome to the SDK Docs!

Welcome to the SDK docs!

cosmonaut reading the cosmos docs in space

Learn the SDK

SDK Intro

If you are a newcomer and would like to learn more about the Cosmos SDK, this intro is a good starting place.

SDK tutorial

If you like to learn by doing, you can follow the SDK application tutorial. It showcases how to build an SDK-based blockchain from scratch, and teaches you about the basic principles the SDK in the process.

Use the SDK

The following sections contain the information you need if you want to build a fully-functional SDK-based blockchain:

NOTE: We are currently working on improving the docs. Some info might be missing. If that is the case, try the Cosmos Forum. Failing that, open an issue.

  • Introduction: Contains introductory high-level material on the Cosmos SDK.
  • Gaia: Contains all documentation related to the gaia application (current name for the Cosmos-Hub). Also contains info on how to join gaia testnets.
  • Clients: Documentation about SDK clients like the SDK Command-Line interface and the SDK Light-client.
  • Specifications: Contains SDK and modules specifications.
  • SDK API Reference: Godocs of the Cosmos-SDK.
  • REST API spec: List of endpoints to interract with a gaia full-node through REST.

If you are reading this on the Cosmos Website, please know that you can find more information on github. Also if you find any issues with the documentation please open a Pull Request, or at least open an Issue to update the docs!

Cosmos Hub testnet

To install the latest version of the gaia application (application of the Cosmos Hub) and join the public testnet, click here

To start your own gaia testnet, click here

Contribute

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

Version

This documentation is built from the following commit: