diff --git a/README.md b/README.md index d432c20819ca..964121e210c9 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ by implementing plugins. 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, +**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. @@ -32,6 +32,7 @@ See the [install guide](/docs/guide/install.md) for more details. 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). diff --git a/docs/guide/basecoin-tool.md b/docs/guide/basecoin-tool.md index 52f42d8320e1..53d8df037802 100644 --- a/docs/guide/basecoin-tool.md +++ b/docs/guide/basecoin-tool.md @@ -1,7 +1,7 @@ # The Basecoin Tool -In previous tutorials we learned the [basics of the `basecoin` CLI](/docs/guides/basecoin-basics) -and [how to implement a plugin](/docs/guides/example-plugin). +In previous tutorials we learned the [basics of the `basecoin` CLI](/docs/guide/basecoin-basics.md) +and [how to implement a plugin](/docs/guide/basecoin-plugins.md). In this tutorial, we provide more details on using the `basecoin` tool. # Data Directory @@ -14,7 +14,7 @@ basecoin init basecoin start ``` -or +or ``` BCHOME=~/.my_basecoin_data basecoin init @@ -33,7 +33,7 @@ basecoin init This will create a single `genesis.json` file in `~/.basecoin` with the information for both Basecoin and Tendermint. -Now, In one window, run +Now, In one window, run ``` basecoin start --without-tendermint @@ -147,7 +147,7 @@ basecoin unsafe_reset_all Any required plugin initialization should be constructed using `SetOption` on genesis. When starting a new chain for the first time, `SetOption` will be called for each item the genesis file. Within genesis.json file entries are made in the format: `"/", ""`, where `` is the plugin name, -and `` and `` are the strings passed into the plugin SetOption function. -This function is intended to be used to set plugin specific information such +and `` and `` are the strings passed into the plugin SetOption function. +This function is intended to be used to set plugin specific information such as the plugin state.