aboutsummaryrefslogtreecommitdiffstats
path: root/cmd/mist/assets/ext/eth.js/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'cmd/mist/assets/ext/eth.js/README.md')
-rw-r--r--cmd/mist/assets/ext/eth.js/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/cmd/mist/assets/ext/eth.js/README.md b/cmd/mist/assets/ext/eth.js/README.md
new file mode 100644
index 000000000..86e2969be
--- /dev/null
+++ b/cmd/mist/assets/ext/eth.js/README.md
@@ -0,0 +1,18 @@
+# Ethereum JavaScript API
+
+This is the Ethereum compatible JavaScript API using `Promise`s
+which implements the [Generic JSON RPC](https://github.com/ethereum/wiki/wiki/Generic-JSON-RPC) spec.
+
+For an example see `index.html`.
+
+**Please note this repo is in it's early stage.**
+
+If you'd like to run a WebSocket ethereum node check out
+[go-ethereum](https://github.com/ethereum/go-ethereum).
+
+To install ethereum and spawn a node:
+
+```
+go get github.com/ethereum/go-ethereum/ethereum
+ethereum -ws -loglevel=4
+```