diff --git a/README.md b/README.md index 7f75aa7..cd3a534 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ This is a proof of concept implementation of a BFT-CRDT blockchain system. +## Prerequisites + +Install a recent version of Rust. + ## Running in development Run the watcher first: @@ -30,6 +34,8 @@ cargo watch -x "run -- run -- node3" cargo watch -x "run -- run -- node4" ``` +You can then type directly into each of the Side Node consoles. Messages will be relayed to each Side Node, and the transaction history will end up being the same on all nodes. + ## Discussion What we have here is a very simple system comprised of two key parts: the Side Node, and the Side Watcher. @@ -38,7 +44,7 @@ What we have here is a very simple system comprised of two key parts: the Side N The Side Nodes make up a system of BFT-CRDT-producing nodes that can make a blockchain. Currently they can reliably send transactions to each other in a secure way, such that all nodes they communicate with can tell whether received transactions are obeying the rules of the system. -Currently the Side Node does not download any chain state, and if one goes off-line it will miss transactions. This is expected at the moment and fairly easy to fix, with a bit of work. +The Side Node does not download any chain state, and if one goes off-line it will miss transactions. This is expected at the moment and fairly easy to fix, with a bit of work. Next dev tasks: