diff --git a/README.md b/README.md index 7476466d6d..d8f1f31831 100644 --- a/README.md +++ b/README.md @@ -282,10 +282,10 @@ limit blocks converge to (`--targetgaslimit`) and the price transactions are acc #### CLI Run `./shyft-geth.sh` with one of the following flags: -- `--setup` - Setups postgres and the shyft chain db -- `--start` - Starts geth +- `--setup` - Setups postgres and the shyft chain db. +- `--start` - Starts geth. - `--reset` - Drops postgress and chain db, and reinstantiates both. -- `--js [web3 filename]` - Executes web3 calls with a passed file name example: filename = sendTransactions.js `--js sendTransactions` +- `--js [web3 filename]` - Executes web3 calls with a passed file name. If the file name is `sendTransactions.js`, `./shyft-geth.sh --js sendTransactions`. Note: An alias can be set for convenience `alias shyft-geth='/shyft_go-ethereum/shyft-geth.sh'` diff --git a/shyft-geth.sh b/shyft-geth.sh index f80ee219f7..f257e38a81 100755 --- a/shyft-geth.sh +++ b/shyft-geth.sh @@ -1,7 +1,14 @@ #!/bin/bash if [[ $# -lt 1 ]]; then - echo Shyft-Geth: No flags detected, refer to readme for available commands. + echo + echo Shyft-Geth: No flags detected, see help: + echo + echo " --setup: Setups postgres and the shyft chain db." + echo " --start: Starts geth." + echo " --reset: Drops postgress and chain db, and reinstantiates both." + echo " --js [filename]: Executes web3 calls with a passed file name. If the file name is sendTransactions.js, $ ./shyft-geth.sh --js sendTransactions" + echo exit 1 fi