-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README: notice this is not ready to use
- Loading branch information
Showing
1 changed file
with
8 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,11 @@ | ||
| # Basecoin | ||
| # Coming soon | ||
|
|
||
| _DISCLAIMER: Basecoin is not associated with Coinbase.com, an excellent Bitcoin/Ethereum service._ | ||
| Cosmos-sdk is the successor to basecoin, but it is not yet ready. All | ||
| development is happening on branches and there is no stable API yet. | ||
|
|
||
| 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. | ||
| It also provides a general purpose framework for extending the feature-set of the cryptocurrency | ||
| by implementing plugins. | ||
| Potential release maybe late September. Please watch this space for details, | ||
| but please don't build on it yet. | ||
|
|
||
| Basecoin 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 basecoin libraries, | ||
| and away you go with a full-stack blockchain and command line tool for transacting. | ||
|
|
||
| WARNING: Currently uses plain-text private keys for transactions and is otherwise not production ready. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| [Install and setup Golang](https://tendermint.com/docs/guides/install-go). | ||
|
|
||
| ## Installation | ||
|
|
||
| ``` | ||
| go get -u github.com/tendermint/basecoin/cmd/basecoin | ||
| ``` | ||
|
|
||
| See the [install guide](/docs/guide/install.md) for more details. | ||
|
|
||
|
|
||
| ## Guide | ||
|
|
||
| 1. Getting started with the [Basecoin basics](/docs/guide/basecoin-basics.md) | ||
| 1. Learning to [use the plugin system](/docs/guide/basecoin-plugins.md) | ||
| 1. More features of the [Basecoin tool](/docs/guide/basecoin-tool.md) | ||
| 1. Learn how to use [InterBlockchain Communication (IBC)](/docs/guide/ibc.md) | ||
| 1. See [more examples](github.com/tendermint/basecoin-examples) | ||
|
|
||
|
|
||
| To deploy a testnet, see our [repository of deployment tools](https://github.com/tendermint/tools). | ||
| You can currently use https://github.com/tendermint/basecoin to build your abci | ||
| apps. Much of the business logic code can be ported over without too | ||
| much difficulty. |