Readme updates

hicommonwealth · Mar 22, 2019 · c486da9 · c486da9
1 parent 4ba523f
commit c486da9
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -10,7 +10,11 @@ To test, use `ganache-cli` and `truffle`
 ```
 truffle test
 ```
-To use the script `/scripts/lockdrop.js`:
+To deploy locally against `ganache-cli`:
+```
+truffle deploy
+```
+To use the script `/scripts/lockdrop.js`, ensure you've deployed to the respective network:
 ```
 truffle compile
 node ./scripts/lockdrop.js --help
@@ -23,7 +27,10 @@ Options:
   -V, --version                     output the version number
   -b, --balance                     Get the total balance across all locks
   -l, --lock                        Lock ETH with the lockdrop
+  -s, --signal <signalingAddress>   Signal a contract balance in the lockdrop
+  -n, --nonce <nonce>               Transaction nonce that created a specific contract address
   -u, --unlock                      Unlock ETH from a specific lock contract
+  -r, --remoteUrl <url>             The remote URL of an Ethereum node (defaults to localhost:8545)
   --lockContractAddress <addr>      The Ethereum address for a lock contract
   --lockdropContractAddress <addr>  lockers
   --lockers                         Get the allocation for the current set of lockers
@@ -33,6 +40,7 @@ Options:
   --pubKey <key>                    Edgeware ED25519 pubKey in hex
   --isValidator                     A boolean flag indicating intent to be a validator
   -h, --help                        output usage information
+
 ```
 
 

diff --git a/scripts/lockdrop.js b/scripts/lockdrop.js
@@ -17,7 +17,7 @@ program
   .option('-s, --signal <signalingAddress>', 'Signal a contract balance in the lockdrop')
   .option('-n, --nonce <nonce>', 'Transaction nonce that created a specific contract address')
   .option('-u, --unlock', 'Unlock ETH from a specific lock contract')
-  .option('-r, --remoteUrl <url>', 'The remote URL of an Ethereum node (defaults to localhost:8545')
+  .option('-r, --remoteUrl <url>', 'The remote URL of an Ethereum node (defaults to localhost:8545)')
   .option('--lockContractAddress <addr>', 'The Ethereum address for a lock contract')
   .option('--lockdropContractAddress <addr>', 'lockers')
   .option('--lockers', 'Get the allocation for the current set of lockers')