improved readme

This commit is contained in:
Fabian Vogelsteller 2017-07-20 12:17:57 +02:00
parent 171817cc9b
commit 3982d54a24
No known key found for this signature in database
GPG Key ID: E51EADA77F1A4124
3 changed files with 24 additions and 21 deletions

View File

@ -1,3 +1,3 @@
ethereum:web3@1.0.0
ethereum:web3@1.0.0-beta1
meteor@1.7.0
underscore@1.0.10

View File

@ -1,5 +1,6 @@
web3.js has moved from 0.x.x to 1.x.x. This is a majore refactor, please read the following guide to update your dapp.
web3.js has moved from 0.x.x to 1.x.x. This is a major refactor, we will provide a guide on how to upgrade in the future.
![](./web3js.jpg)
# web3.js - Ethereum JavaScript API
@ -37,51 +38,53 @@ Bower
bower install web3
```
Component
```bash
component install ethereum/web3.js
```
* Include `web3.min.js` in your html file. (not required for the meteor package)
Or Include `dist/web3.min.js` in your html file.
## Usage
Use the `web3` object directly from global namespace:
Use the `Web3` object directly from global namespace:
```js
console.log(web3); // {eth: .., shh: ...} // it's here!
var web3 = new Web3('ws://localhost:8546');
console.log(Web3);
> {
eth: ... ,
shh: ... ,
utils: ...,
...
}
```
Set a provider (HttpProvider)
Additionally you can set a provider using `web3.setProvider()` (e.g. WebsocketProvider)
```js
web3.setProvider(new web3.providers.HttpProvider('http://localhost:8545'));
web3.setProvider('ws://localhost:8546');
// or
web3.setProvider(new Web3.providers.WebsocketProvider('ws://localhost:8546'));
```
There you go, now you can use it:
```js
var coinbase = web3.eth.coinbase;
var balance = web3.eth.getBalance(coinbase);
web3.eth.getAccounts()
.then(console.log);
```
You can find more examples in [`example`](https://github.com/ethereum/web3.js/tree/master/example) directory.
## Documentation
Documentation can be found at [read the docs](http://web3js.readthedocs.io/en/latest/)
Documentation can be found at [read the docs](http://web3js.readthedocs.io/en/1.0/)
## Building
### Requirements
* Node.js
* [Node.js](https://nodejs.org)
* npm
```bash
sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm
sudo apt-get install nodejs-legacy
```
### Building (gulp)

BIN
web3js.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB