From 29b8161ac6dfe5663c32e02b8eda4a2c72a2d3c5 Mon Sep 17 00:00:00 2001 From: Marko Date: Tue, 3 Sep 2019 14:59:24 +0200 Subject: [PATCH] Merge PR #4981: Quick fix for broken links --- README.md | 6 +++--- docs/README.md | 12 ++++++------ 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 782cc949c..6e2595af2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Cosmos SDK + ![banner](docs/cosmos-sdk-image.jpg) [![version](https://img.shields.io/github/tag/cosmos/cosmos-sdk.svg)](https://github.com/cosmos/cosmos-sdk/releases/latest) @@ -7,8 +8,7 @@ [![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) -[![API Reference](https://godoc.org/github.com/cosmos/cosmos-sdk?status.svg -)](https://godoc.org/github.com/cosmos/cosmos-sdk) +[![API Reference](https://godoc.org/github.com/cosmos/cosmos-sdk?status.svg)](https://godoc.org/github.com/cosmos/cosmos-sdk) [![riot.im](https://img.shields.io/badge/riot.im-JOIN%20CHAT-green.svg)](https://riot.im/app/#/room/#cosmos-sdk:matrix.org) The Cosmos-SDK is a framework for building blockchain applications in Golang. @@ -21,7 +21,7 @@ breaking changes. ## Quick Start -To learn how the SDK works from a high-level perspective, go to the [SDK Intro](./docs/intro/README.md). +To learn how the SDK works from a high-level perspective, go to the [SDK Intro](./docs/intro/intro.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. diff --git a/docs/README.md b/docs/README.md index c80428ad3..aa68d54a9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,12 +2,12 @@ ## Get Started -- **[SDK Intro](./intro/README.md)**: High-level overview of the Cosmos SDK. -- **[SDK application tutorial](https://github.com/cosmos/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. +- **[SDK Intro](./intro/intro.md)**: High-level overview of the Cosmos SDK. +- **[SDK application tutorial](https://github.com/cosmos/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](./spec/README.md): Specifications of modules and other parts of the Cosmos SDK. +- [Specifications](./spec/README.md): Specifications of modules and other parts of the Cosmos SDK. - [SDK API Reference](https://godoc.org/github.com/cosmos/cosmos-sdk): Godocs of the Cosmos SDK. - [REST API spec](https://cosmos.network/rpc/): List of endpoints to interact with a `gaia` full-node through REST. @@ -15,10 +15,10 @@ To create a new project, you can either: -- Fork [this repo](https://github.com/cosmos/sdk-application-tutorial/). Do not forget to remove the `nameservice` module from the various files if you don't need it. +- Fork [this repo](https://github.com/cosmos/sdk-application-tutorial/). Do not forget to remove the `nameservice` module from the various files if you don't need it. - Use community tools like [chainkit](https://github.com/blocklayerhq/chainkit). -## Cosmos Hub +## Cosmos Hub The Cosmos Hub (`gaia`) docs have moved [here](https://github.com/cosmos/gaia/tree/master/docs). @@ -35,4 +35,4 @@ considerations when making changes. ## Version - This documentation is built from the following commit: +This documentation is built from the following commit: