mirror of
https://github.com/status-im/web3.js.git
synced 2025-02-22 19:18:07 +00:00
updated README.md
This commit is contained in:
parent
4583998bfb
commit
d7dd92169b
28
README.md
28
README.md
@ -17,40 +17,52 @@ You need to run a local ethrereum node to use this library.
|
||||
|
||||
### Node.js
|
||||
|
||||
$ npm install web3
|
||||
```bash
|
||||
npm install web3
|
||||
```
|
||||
|
||||
### Meteor.js
|
||||
|
||||
$ meteor add ethereum:web3
|
||||
```bash
|
||||
meteor add ethereum:web3
|
||||
```
|
||||
|
||||
### As Browser module
|
||||
Bower
|
||||
|
||||
$ bower install web3
|
||||
```bash
|
||||
bower install web3
|
||||
```
|
||||
|
||||
Component
|
||||
|
||||
$ component install ethereum/web3.js
|
||||
```bash
|
||||
component install ethereum/web3.js
|
||||
```
|
||||
|
||||
* Include `ethereum.min.js` in your html file. (not required for the meteor package)
|
||||
|
||||
## Usage
|
||||
Use the `web3` object directly from global namespace:
|
||||
|
||||
console.log(web3); // {eth: .., shh: ...} // it's here!
|
||||
```js
|
||||
console.log(web3); // {eth: .., shh: ...} // it's here!
|
||||
```
|
||||
|
||||
Set a provider (HttpProvider)
|
||||
|
||||
web3.setProvider(new web3.providers.HttpProvider('http://localhost:8545'));
|
||||
```js
|
||||
web3.setProvider(new web3.providers.HttpProvider('http://localhost:8545'));
|
||||
```
|
||||
|
||||
There you go, now you can use it:
|
||||
|
||||
```
|
||||
```js
|
||||
var coinbase = web3.eth.coinbase;
|
||||
var balance = web3.eth.getBalance(coinbase);
|
||||
```
|
||||
|
||||
For another example see `example/index.html`.
|
||||
You can find more examples in [`example`](https://github.com/ethereum/web3.js/tree/master/example) directory.
|
||||
|
||||
|
||||
## Contribute!
|
||||
|
Loading…
x
Reference in New Issue
Block a user