update readme

This commit is contained in:
greg 2018-06-03 18:15:16 -04:00
parent 985ddce0d2
commit 88d516c9d0
2 changed files with 20 additions and 3 deletions

View file

@ -277,6 +277,18 @@ Which will start mining blocks and transactions on a single CPU thread, creditin
the account specified by `--etherbase`. You can further tune the mining by changing the default gas the account specified by `--etherbase`. You can further tune the mining by changing the default gas
limit blocks converge to (`--targetgaslimit`) and the price transactions are accepted at (`--gasprice`). limit blocks converge to (`--targetgaslimit`) and the price transactions are accepted at (`--gasprice`).
## SHYFT NOTES
#### CLI
Run `./shyft-geth.sh` with one of the following flags:
- `--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`
Note: An alias can be set for convenience `alias shyft-geth='<path/to/shyft/geth>/shyft_go-ethereum/shyft-geth.sh'`
## Contribution ## Contribution
Thank you for considering to help out with the source code! We welcome contributions from Thank you for considering to help out with the source code! We welcome contributions from

View file

@ -1,5 +1,10 @@
#!/bin/bash #!/bin/bash
if [[ $# -lt 1 ]]; then
echo Shyft-Geth: No flags detected, refer to readme for available commands.
exit 1
fi
illegalCommands=() illegalCommands=()
while [[ $# -gt 0 ]] while [[ $# -gt 0 ]]
do do
@ -15,7 +20,7 @@ case $key in
shift # past argument shift # past argument
;; ;;
--js) --js)
sh ./shyft-cli/runJs.sh ./shyft-cli/web3/$2 sh ./shyft-cli/runJs.sh ./shyft-cli/web3/$2.js
shift # past argument shift # past argument
shift # past argument shift # past argument
;; ;;
@ -30,7 +35,7 @@ case $key in
esac esac
done done
if [[ "${#illegalCommands[@]}" -gt "0" ]] ; then if [[ "${#illegalCommands[@]}" -gt "0" ]]; then
echo The following commands are not supported: "${illegalCommands[*]}" echo Shyft-Geth: The following commands are not supported: "${illegalCommands[*]}"
fi fi