Skip to content

Commit 5ab9450

Browse files
committed
README: notice this is not ready to use
1 parent 47dd2c6 commit 5ab9450

File tree

1 file changed

+8
-35
lines changed

1 file changed

+8
-35
lines changed

README.md

+8-35
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,11 @@
1-
# Basecoin
1+
# Coming soon
22

3-
_DISCLAIMER: Basecoin is not associated with Coinbase.com, an excellent Bitcoin/Ethereum service._
3+
Cosmos-sdk is the successor to basecoin, but it is not yet ready. All
4+
development is happening on branches and there is no stable API yet.
45

5-
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.
6-
It also provides a general purpose framework for extending the feature-set of the cryptocurrency
7-
by implementing plugins.
6+
Potential release maybe late September. Please watch this space for details,
7+
but please don't build on it yet.
88

9-
Basecoin serves as a reference implementation for how we build ABCI applications in Go,
10-
and is the framework in which we implement the [Cosmos Hub](https://cosmos.network).
11-
**It's easy to use, and doesn't require any forking** - just implement your plugin, import the basecoin libraries,
12-
and away you go with a full-stack blockchain and command line tool for transacting.
13-
14-
WARNING: Currently uses plain-text private keys for transactions and is otherwise not production ready.
15-
16-
## Prerequisites
17-
18-
[Install and setup Golang](https://tendermint.com/docs/guides/install-go).
19-
20-
## Installation
21-
22-
```
23-
go get -u github.com/tendermint/basecoin/cmd/basecoin
24-
```
25-
26-
See the [install guide](/docs/guide/install.md) for more details.
27-
28-
29-
## Guide
30-
31-
1. Getting started with the [Basecoin basics](/docs/guide/basecoin-basics.md)
32-
1. Learning to [use the plugin system](/docs/guide/basecoin-plugins.md)
33-
1. More features of the [Basecoin tool](/docs/guide/basecoin-tool.md)
34-
1. Learn how to use [InterBlockchain Communication (IBC)](/docs/guide/ibc.md)
35-
1. See [more examples](github.com/tendermint/basecoin-examples)
36-
37-
38-
To deploy a testnet, see our [repository of deployment tools](https://github.com/tendermint/tools).
9+
You can currently use https://github.com/tendermint/basecoin to build your abci
10+
apps. Much of the business logic code can be ported over without too
11+
much difficulty.

0 commit comments

Comments
 (0)