diff --git a/README.md b/README.md index 5fc0fc853096d703d8ad6445a1c7a2fe15a78163..285449c1549ee1a31f38f50cac993dd5f9754728 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,9 @@ | Master | [](https://circleci.com/gh/hyperledger/burrow/tree/master) | | Develop | [](https://circleci.com/gh/hyperledger/burrow/tree/develop) | -Hyperledger Burrow is a permissioned Ethereum smart-contract blockchain node built with <3 by Monax. It executes Ethereum EVM smart contract code (usually written in [Solidity](https://solidity.readthedocs.io)) on a permissioned virtual machine. Burrow provides transaction finality and high transaction throughput on a proof-of-stake [Tendermint](https://tendermint.com) consensus engine. +Hyperledger Burrow is a permissioned Ethereum smart-contract blockchain node. It executes Ethereum EVM smart contract code (usually written in [Solidity](https://solidity.readthedocs.io)) on a permissioned virtual machine. Burrow provides transaction finality and high transaction throughput on a proof-of-stake [Tendermint](https://tendermint.com) consensus engine. + + ## What is Burrow @@ -63,7 +65,7 @@ Once the `burrow.toml` has been created, we run: ``` # To select our validator address by index in the GenesisDoc -burrow serve --validator-index=0 +burrow serve --validator-index=0 # Or to select based on address directly (substituting the example address below with your validator's): burrow serve --validator-address=BE584820DC904A55449D7EB0C97607B40224B96E ``` @@ -75,7 +77,7 @@ multi-node chain it will resync with peers, otherwise it will restart from heigh ### Logging -Logging is highly configurable through the `burrow.toml` `[logging]` section. Each log line is a list of key-value pairs that flows from the root sink through possible child sinks. Each sink can have an output, a transform, and sinks that it outputs to. Below is a more involved example than the one appearing in the default generated config of what you can configure: +Logging is highly configurable through the `burrow.toml` `[logging]` section. Each log line is a list of key-value pairs that flows from the root sink through possible child sinks. Each sink can have an output, a transform, and sinks that it outputs to. Below is a more involved example than the one appearing in the default generated config of what you can configure: ```toml # This is a top level config section within the main Burrow config diff --git a/docs/images/burrow.png b/docs/images/burrow.png new file mode 100644 index 0000000000000000000000000000000000000000..73ae58e608e97004d3668011ca84af797cabd0fd Binary files /dev/null and b/docs/images/burrow.png differ