spiff up readme, #146
This commit is contained in:
parent
1ad317642e
commit
1408eb65a4
42
README.md
42
README.md
@ -1,36 +1,42 @@
|
||||
# Quark
|
||||
# Cosmos SDK
|
||||
|
||||
Quark is an [ABCI application](https://github.com/tendermint/abci) designed to
|
||||
be used with the [Tendermint consensus engine](https://tendermint.com/) to form
|
||||
a Proof-of-Stake cryptocurrency. It also provides a general purpose framework
|
||||

|
||||
|
||||
[](https://github.com/cosmos/cosmos-sdk/releases/latest)
|
||||
[](https://godoc.org/github.com/cosmos/cosmos-sdk)
|
||||
[](https://cosmos.rocket.chat/)
|
||||
[](https://github.com/cosmos/cosmos-sdk/blob/master/LICENSE)
|
||||
|
||||
Branch | Tests | Coverage | Report Card
|
||||
----------|-------|----------|-------------
|
||||
develop | [](https://circleci.com/gh/cosmos/cosmos-sdk/tree/develop) | [](https://codecov.io/gh/cosmos/cosmos-sdk) | [](https://goreportcard.com/report/github.com/cosmos/cosmos-sdk/tree/develop)
|
||||
master | [](https://circleci.com/gh/cosmos/cosmos-sdk/tree/master) | [](https://codecov.io/gh/cosmos/cosmos-sdk) | [](https://goreportcard.com/report/github.com/cosmos/cosmos-sdk/tree/master)
|
||||
|
||||
The Cosmos SDK is an [ABCI application](https://github.com/tendermint/abci) designed to be used with the [Tendermint consensus engine](https://tendermint.com/) to form a Proof-of-Stake cryptocurrency. It also provides a general purpose framework
|
||||
for extending the feature-set of the cryptocurrency by implementing plugins.
|
||||
|
||||
Quark serves as a reference implementation for how we build ABCI applications
|
||||
in Go, and is the framework in which we implement the [Cosmos
|
||||
Hub](https://cosmos.network). **It's easy to use, and doesn't require any
|
||||
forking** - just implement your plugin, import the quark libraries, and away
|
||||
Within this repository, the `basecoin` app serves as a reference implementation for how we build ABCI applications in Go, and is the framework in which we implement the [Cosmos Hub](https://cosmos.network). **It's easy to use, and doesn't require any forking** - just implement your plugin, import the libraries, and away
|
||||
you go with a full-stack blockchain and command line tool for transacting.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
[Install and setup Golang](https://tendermint.com/docs/guides/install-go).
|
||||
* [golang](https://golang.org/doc/install)
|
||||
|
||||
## Installation
|
||||
|
||||
```
|
||||
go get -u github.com/tendermint/basecoin/cmd/basecoin
|
||||
go get -u github.com/cosmos/cosmos-sdk/cmd/basecoin
|
||||
```
|
||||
|
||||
See the [install guide](/docs/guide/install.md) for more details.
|
||||
|
||||
## Guides
|
||||
|
||||
## Guide
|
||||
|
||||
1. Getting started with the [Quark basics](/docs/guide/basecoin-basics.md)
|
||||
1. Learning to [use the plugin system](/docs/guide/basecoin-plugins.md)
|
||||
1. More features of the [Quark tool](/docs/guide/basecoin-tool.md)
|
||||
1. Learn how to use [Inter-Blockchain Communication (IBC)](/docs/guide/ibc.md)
|
||||
1. See [more examples](https://github.com/tendermint/basecoin-examples)
|
||||
|
||||
* Getting started with the [Basecoin basics](/docs/guide/basecoin-basics.md)
|
||||
* Learn to [use the plugin system](/docs/guide/basecoin-plugins.md)
|
||||
* More features of the [Basecoin tool](/docs/guide/basecoin-tool.md)
|
||||
* Learn how to use [Inter-Blockchain Communication (IBC)](/docs/guide/ibc.md)
|
||||
* See [more examples](https://github.com/cosmos/cosmos-academy)
|
||||
|
||||
To deploy a testnet, see our [repository of deployment tools](https://github.com/tendermint/tools).
|
||||
|
||||
BIN
cosmos-sdk-image.png
Normal file
BIN
cosmos-sdk-image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 243 KiB |
Loading…
Reference in New Issue
Block a user