add readme
This commit is contained in:
parent
5b8de01a0c
commit
78ad50a447
48
README.md
48
README.md
|
@ -1,3 +1,51 @@
|
||||||
# Liquid Funding Console
|
# 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`
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue