cosmos-sdk/README.md

39 lines
1.6 KiB
Markdown
Raw Normal View History

2017-01-26 13:48:54 -08:00
# Basecoin
2017-02-12 19:05:27 -08:00
_DISCLAIMER: Basecoin is not associated with Coinbase.com, an excellent Bitcoin/Ethereum service._
2017-01-26 13:48:54 -08:00
2017-02-12 19:05:27 -08:00
Basecoin 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.
2017-02-03 18:17:11 -08:00
It also provides a general purpose framework for extending the feature-set of the cryptocurrency
by implementing plugins.
2017-01-26 13:48:54 -08:00
2017-02-03 18:17:11 -08:00
Basecoin serves as a reference implementation for how we build ABCI applications in Go,
2017-02-08 04:18:26 -08:00
and is the framework in which we implement the [Cosmos Hub](https://cosmos.network).
2017-04-30 16:50:14 -07:00
**It's easy to use, and doesn't require any forking** - just implement your plugin, import the basecoin libraries,
2017-02-03 18:17:11 -08:00
and away you go with a full-stack blockchain and command line tool for transacting.
2017-01-26 13:48:54 -08:00
2017-02-03 18:17:11 -08:00
WARNING: Currently uses plain-text private keys for transactions and is otherwise not production ready.
2017-01-26 13:48:54 -08:00
2017-03-01 13:01:47 -08:00
## Prerequisites
[Install and setup Golang](https://tendermint.com/docs/guides/install-go).
2017-03-01 13:01:47 -08:00
2017-01-26 13:48:54 -08:00
## Installation
2017-02-10 13:40:20 -08:00
```
go get -u github.com/tendermint/basecoin/cmd/basecoin
```
See the [install guide](/docs/guide/install.md) for more details.
2017-02-10 13:40:20 -08:00
2017-01-29 12:48:28 -08:00
## Guide
2017-01-29 15:23:50 -08:00
2017-03-14 22:17:12 -07:00
1. Getting started with the [Basecoin basics](/docs/guide/basecoin-basics.md)
2017-04-26 21:54:56 -07:00
1. Learning to [use the plugin system](/docs/guide/basecoin-plugins.md)
1. More features of the [Basecoin tool](/docs/guide/basecoin-tool.md)
2017-02-04 21:43:55 -08:00
1. Learn how to use [InterBlockchain Communication (IBC)](/docs/guide/ibc.md)
2017-04-30 16:50:14 -07:00
1. See [more examples](github.com/tendermint/basecoin-examples)
2017-01-29 15:23:50 -08:00
2017-04-26 21:54:56 -07:00
To deploy a testnet, see our [repository of deployment tools](https://github.com/tendermint/tools).