aboutsummaryrefslogtreecommitdiffstats
path: root/cmd/clef/README.md
diff options
context:
space:
mode:
authorMartin Holst Swende <martin@swende.se>2018-05-02 18:31:05 +0800
committerPéter Szilágyi <peterke@gmail.com>2018-05-02 18:31:05 +0800
commit5d4d79ae2672b295a539cf3ce0163b2cb10eb2b2 (patch)
treed56b5e8aa13a14d27aa3ce52b8f59cff304927ea /cmd/clef/README.md
parent6a01363d1ddb15fa79817c425de472066e72a094 (diff)
downloaddexon-5d4d79ae2672b295a539cf3ce0163b2cb10eb2b2.tar
dexon-5d4d79ae2672b295a539cf3ce0163b2cb10eb2b2.tar.gz
dexon-5d4d79ae2672b295a539cf3ce0163b2cb10eb2b2.tar.bz2
dexon-5d4d79ae2672b295a539cf3ce0163b2cb10eb2b2.tar.lz
dexon-5d4d79ae2672b295a539cf3ce0163b2cb10eb2b2.tar.xz
dexon-5d4d79ae2672b295a539cf3ce0163b2cb10eb2b2.tar.zst
dexon-5d4d79ae2672b295a539cf3ce0163b2cb10eb2b2.zip
cmd/clef: documentation about setup (#16568)
clef: documentation about setup
Diffstat (limited to 'cmd/clef/README.md')
-rw-r--r--cmd/clef/README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/cmd/clef/README.md b/cmd/clef/README.md
index 93799a761..027c22c98 100644
--- a/cmd/clef/README.md
+++ b/cmd/clef/README.md
@@ -12,6 +12,11 @@ synchronised with the chain or a particular Ethereum node that has no built-in (
Clef can run as a daemon on the same machine, or off a usb-stick like [usb armory](https://inversepath.com/usbarmory),
or a separate VM in a [QubesOS](https://www.qubes-os.org/) type os setup.
+Check out
+
+* the [tutorial](tutorial.md) for some concrete examples on how the signer works.
+* the [setup docs](docs/setup.md) for some information on how to configure it to work on QubesOS or USBArmory.
+
## Command line flags
Clef accepts the following command line options:
@@ -49,7 +54,6 @@ Example:
signer -keystore /my/keystore -chainid 4
```
-Check out the [tutorial](tutorial.md) for some concrete examples on how the signer works.
## Security model
@@ -862,3 +866,12 @@ A UI should conform to the following rules.
along with the UI.
+### UI Implementations
+
+There are a couple of implementation for a UI. We'll try to keep this list up to date.
+
+| Name | Repo | UI type| No external resources| Blocky support| Verifies permissions | Hash information | No secondary storage | Statically linked| Can modify parameters|
+| ---- | ---- | -------| ---- | ---- | ---- |---- | ---- | ---- | ---- |
+| QtSigner| https://github.com/holiman/qtsigner/| Python3/QT-based| :+1:| :+1:| :+1:| :+1:| :+1:| :x: | :+1: (partially)|
+| GtkSigner| https://github.com/holiman/gtksigner| Python3/GTK-based| :+1:| :x:| :x:| :+1:| :+1:| :x: | :x: |
+| Frame | https://github.com/floating/frame/commits/go-signer| Electron-based| :x:| :x:| :x:| :x:| ?| :x: | :x: |