Getting started

README.md

@@ -1,8 +1,33 @@
-# ZecWallet light client. 
+# Zeclite CLI - A command line ZecWallet light client. 
+
+`zeclite-cli` is a command line zecwallet light client. To use it, download the latest binary from the releases page and run `./zeclite-cli`
+
+This will launch the interactive prompt. Type `help` to get a list of commands
+
+**zeclite-cli is currently in beta**
 
-Coming soon...
 
 ## Compiling from source
 
 #### Pre-requisites
-* Rust v1.37 or higher. (Run `rustup update` to get the latest version of Rust if you already have it installed)
+* Rust v1.37 or higher.
+    * Run `rustup update` to get the latest version of Rust if you already have it installed
+
+```
+git clone https://github.com/adityapk00/lightwalletclient.git
+cargo build --release
+./target/release/zeclite-cli
+```
+
+## Options
+CLI arguments you can pass to `zeclite-cli`
+
+* `--server`: Connect to a custom zeclite lightwalletd server. 
+    * Example: `./zeclite-cli --server 127.0.0.1:9067`
+* `--seed`: Restore a wallet from a seed phrase. Note that this will fail if there is an existing wallet. Delete (or move) any existing wallet to restore from the 24-word seed phrase
+    * Example: `./zeclite-cli --seed "twenty four words seed phrase"`
+
+## Notes:
+* The wallet is currently testnet only
+* If you want to run your own server, please see [zeclite lightwalletd](https://github.com/adityapk00/lightwalletd), and then run `./zeclite-cli --server 127.0.0.1:9067`
+* Support for reorgs is iffy. It your wallet gets into an inconsistent state, type `rescan` to reset the wallet.