From 78ad50a447ff92947c12cf63b74c8959b8495ba4 Mon Sep 17 00:00:00 2001
From: Iuri Matias <iuri.matias@gmail.com>
Date: Sun, 26 May 2019 19:50:22 -0400
Subject: [PATCH] add readme

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

diff --git a/README.md b/README.md
index b0a084a..8218219 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,51 @@
 # Liquid Funding Console
 
+# Usage
+
+```
+Usage: index [options]
+
+Options:
+-V, --version              output the version number
+-u, --url [url]            host to connect to (default: ws://localhost:8556)
+-a, --accounts [accounts]  accounts file, if not defined uses accounts in the connecting node
+-c, --chain [chain]        environment to run, can be mainnet, ropsten, development (default: development)
+-i, --index [index]        account index to use (default: 0)
+-h, --help                 output usage information
+```
+
+# Connecting to a network
+
+The intended chains needs to be specified with `-c`, and the endpoint with `-u`, in the case of using something like infura, an account needs to be specified.
+
+example:
+
+`node src/index.js -c ropsten -u https://ropsten.infura.io/nm12345678 -a "accounts.json"`
+
+# Configuring accounts
+
+create & configure a account json file then pass it as a paramater `-a`
+
+```
+{
+  "accounts": [
+    {
+      "mnemonic": "add mnemonic here",
+      "numAddresses": 1
+    }
+  ]
+}
+```
+
+# Local usage
+
+1. run embark
+
+`npx embark run`
+
+type `devtxs on`
+
+2. run the dapp
+
+`node src/index.js`