Updated consensus engine documentation.

openrelayxyz · Jul 31, 2023 · 297b3a6 · 297b3a6
1 parent 5884988
commit 297b3a6
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/packages/consensus-engine/README.md b/packages/consensus-engine/README.md
@@ -4,7 +4,7 @@ This is an mvp and proof of concept plugin. The PluGeth hooks and injections all
 
 This package provides a bash script which instantiates two separate nodes: a miner and a passive node. The `BlockChain` method in `main.go` then sends two contracts to the chain triggering the mining of two blocks. 
 
-In addition to foundation Geth we support other forks as well. As such there are multiple bash scripts contained in this project to initiate the plugin to work on the commiserate chain. 
+In addition to foundation Geth we support other forks as well. As such there are multiple bash scripts contained in this project to initiate the plugin to work on the commiserate chain. A not about separate chains: Ultimately this plugin was designed to be used with foundation Geth. Our vision for the plugin is to support modifying foundation Geth to enable desperate implementation and thus new chains. As such the functionality is diminished for our plugeth-etc project. Use with caution.  
 
 In order to use the plugin navigate to the `/chain` directory. Change the permissions on the appropriate bash file.  Then point the executable file to a Geth binary like so: `/path/to/geth/geth` `./blockchain.sh `.  After a few seconds the application should close with exit code 0.