Added better WalletTools description.

8paa · Oct 17, 2013 · 6e01daa · 6e01daa
1 parent 27e2d8b
commit 6e01daa
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/contrib/wallettools/README.md b/contrib/wallettools/README.md
@@ -1,2 +1,4 @@
 ### Wallet Tools ###
-Contains a wallet change password and unlock script.
+These are two simple python scripts which send the appropriate RPC commands to unlock a wallet and change a wallet password. **They are intended to prevent users from having to enter their password as a command-line argument which could then be stored in the console buffer/history in plaintext.**
+
+Both tools rely on bitcoin/bitcoind running with `server=1` and an `rpcuser` and `rpcpassword` set in `bitcoin.conf`. They can be easily modified for non-standard ports. [walletunlock.py](/contrib/wallettools/walletunlock.py) unlocks the wallet for 60 seconds by default, changeable in code, and both modules rely upon python-json-rpc.