diff options
author | Marian Oancea <contact@siteshop.ro> | 2014-11-06 01:46:01 +0800 |
---|---|---|
committer | Marian Oancea <contact@siteshop.ro> | 2014-11-06 01:46:01 +0800 |
commit | 4be4db5e6cfdde4ba5c1243b2bafeb6bbae3643c (patch) | |
tree | c368675984eb642f13334f2e61f6401d58776863 /README.md | |
parent | 3e174a08790ca009a2107a3564b179ae1f036c33 (diff) | |
download | go-tangerine-4be4db5e6cfdde4ba5c1243b2bafeb6bbae3643c.tar go-tangerine-4be4db5e6cfdde4ba5c1243b2bafeb6bbae3643c.tar.gz go-tangerine-4be4db5e6cfdde4ba5c1243b2bafeb6bbae3643c.tar.bz2 go-tangerine-4be4db5e6cfdde4ba5c1243b2bafeb6bbae3643c.tar.lz go-tangerine-4be4db5e6cfdde4ba5c1243b2bafeb6bbae3643c.tar.xz go-tangerine-4be4db5e6cfdde4ba5c1243b2bafeb6bbae3643c.tar.zst go-tangerine-4be4db5e6cfdde4ba5c1243b2bafeb6bbae3643c.zip |
Converted to node module
Converted to npm package
Added brower
Added browserify with minification
Updated Readme
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 52 |
1 files changed, 50 insertions, 2 deletions
@@ -1,9 +1,57 @@ # 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. +which implements the [Generic JSON RPC](https://github.com/ethereum/wiki/wiki/Generic-JSON-RPC) spec. It's available on npm as a node module and also for bower and component as an embeddable js -For an example see `index.html`. +### Installation + +## Node.js + + npm install ethereum.js + +## For browser +Bower + + bower install ethereum.js + +Component + + component install ethereum/ethereum.js + +* Include `ethereum.min.js` in your html file. +* Include [es6-promise](https://github.com/jakearchibald/es6-promise) or another ES6-Shim if your browser doesn't support ECMAScript 6. + +### Usage +Require the library: + + var web3 = require('web3'); + +Set a provider (QtProvider, WebSocketProvider, HttpRpcProvider) + + var web3.setProvider(new web3.providers.WebSocketProvider('ws://localhost:40404/eth')); + +There you go, now you can use it: + +``` +web3.eth.coinbase.then(function(result){ + console.log(result); + return web3.eth.balanceAt(result); +}).then(function(balance){ + console.log(web3.toDecimal(balance)); +}).catch(function(err){ + console.log(err); +}); +``` + + +For another example see `example/index.html`. + +### Building + +* `gulp build` + + +### Testing **Please note this repo is in it's early stage.** |