1
1
<p align =" center " >
2
- <img src =" https://github.com/ethereum/web3.js/raw/1.x/ web3js.jpg" width =200 / >
2
+ <img src =" assets/logo/ web3js.jpg" width =" 200 " alt = " web3.js " >
3
3
</p >
4
4
5
5
# web3.js - Ethereum JavaScript API
6
6
7
- [ ![ Join the chat at https://gitter.im/ethereum/web3.js ] ( https://badges. gitter.im/Join%20Chat.svg )] ( https:// gitter.im/ethereum/web3.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge ) [ ![ npm] ( https://img.shields.io/ npm/dm/web3.svg )] ( https://www.npmjs.com/package/web3 ) [ ![ Build Status] [ travis-image ]] [ travis-url ] [ ![ dependency status ] [ dep -image]] [ dep -url] [ ![ dev dependency status ] [ dep -dev-image]] [ dep -dev-url] [ ![ Coverage Status] [ coveralls-image ]] [ coveralls-url ]
8
- [ ![ lerna] ( https://img.shields.io/badge/maintained%20with- lerna-cc00ff.svg )] ( https:// lerna.js.org/ )
7
+ [ ![ Gitter ] [ gitter-image ]] [ gitter-url ] [ ![ StackExchange ] [ stackexchange-image ]] [ stackexchange-url ] [ ![ NPM Package ] [ npm-image ]] [ npm-url ] [ ![ Build Status] [ travis-image ]] [ travis-url ] [ ![ Dependency Status ] [ deps -image]] [ deps -url] [ ![ Dev Dpendency Status ] [ deps -dev-image]] [ deps -dev-url] [ ![ Coverage Status] [ coveralls-image ]] [ coveralls-url ]
8
+ [ ![ lerna] [ lerna-image ]] [ lerna-url ]
9
9
10
10
This is the Ethereum [ JavaScript API] [ docs ]
11
- which connects to the [ Generic JSON RPC] ( https://github.com/ethereum/wiki/wiki/JSON-RPC ) spec.
11
+ which connects to the [ Generic JSON- RPC] ( https://github.com/ethereum/wiki/wiki/JSON-RPC ) spec.
12
12
13
13
You need to run a local or remote [ Ethereum] ( https://www.ethereum.org/ ) node to use this library.
14
14
@@ -40,16 +40,18 @@ npm run-script build
40
40
Then include ` dist/web3.js ` in your html file.
41
41
This will expose ` Web3 ` on the window object.
42
42
43
- Or via jsDelivr CDN
43
+ Or via jsDelivr CDN:
44
44
45
45
``` html
46
46
<script src =" https://cdn.jsdelivr.net/npm/web3@latest/dist/web3.min.js" ></script >
47
47
```
48
- UNPKG
48
+
49
+ UNPKG:
49
50
50
51
``` html
51
52
<script src =" https://unpkg.com/web3@latest/dist/web3.min.js" ></script >
52
53
```
54
+
53
55
## Usage
54
56
55
57
``` js
@@ -102,7 +104,7 @@ If you are using the types in a `commonjs` module like for example a node app yo
102
104
103
105
## Documentation
104
106
105
- Documentation can be found at [read the docs ][docs].
107
+ Documentation can be found at [ReadTheDocs ][docs].
106
108
107
109
## Building
108
110
@@ -119,7 +121,7 @@ sudo apt-get install npm
119
121
120
122
### Building (gulp)
121
123
122
- Build only the web3.js package
124
+ Build only the web3.js package:
123
125
124
126
` ` ` bash
125
127
npm run- script build
@@ -145,7 +147,8 @@ The contribution guidelines are provided in [CONTRIBUTIONS](./CONTRIBUTIONS.md)
145
147
146
148
### Community
147
149
148
- - [Gitter](https://gitter.im/ethereum/web3.js?source=orgpage)
150
+ - [Gitter][gitter-url]
151
+ - [StackExchange][stackexchange-url]
149
152
- [Forum](https://forum.ethereum.org/categories/ethereum-js)
150
153
151
154
### Similar libraries in other languages
@@ -160,15 +163,21 @@ The contribution guidelines are provided in [CONTRIBUTIONS](./CONTRIBUTIONS.md)
160
163
161
164
[repo]: https://github.com/ethereum/web3.js
162
165
[docs]: http://web3js.readthedocs.io/
163
- [npm-image]: https://badge.fury .io/js/ web3.png
166
+ [npm-image]: https://img.shields .io/npm/dm/ web3.svg
164
167
[npm-url]: https://npmjs.org/package/web3
165
- [travis-image]: https://travis-ci.org/ethereum/web3.js.svg
166
- [travis-url]: https://travis-ci.org/ethereum/web3.js
167
- [dep -image]: https://david-dm.org/ethereum/web3.js.svg
168
- [dep -url]: https://david-dm.org/ethereum/web3.js
169
- [dep -dev-image]: https://david-dm.org/ethereum/web3.js/dev-status.svg
170
- [dep -dev-url]: https://david-dm.org/ethereum/web3.js#info=devDependencies
168
+ [travis-image]: https://travis-ci.org/ethereum/web3.js.svg?branch=1.x
169
+ [travis-url]: https://travis-ci.org/ethereum/web3.js?branch=1.x
170
+ [deps -image]: https://david-dm.org/ethereum/web3.js.svg
171
+ [deps -url]: https://david-dm.org/ethereum/web3.js
172
+ [deps -dev-image]: https://david-dm.org/ethereum/web3.js/dev-status.svg
173
+ [deps -dev-url]: https://david-dm.org/ethereum/web3.js#info=devDependencies
171
174
[coveralls-image]: https://coveralls.io/repos/ethereum/web3.js/badge.svg?branch=1.x
172
175
[coveralls-url]: https://coveralls.io/r/ethereum/web3.js?branch=1.x
173
176
[waffle-image]: https://badge.waffle.io/ethereum/web3.js.svg?label=ready&title=Ready
174
177
[waffle-url]: https://waffle.io/ethereum/web3.js
178
+ [gitter-image]: https://badges.gitter.im/Join%20Chat.svg
179
+ [gitter-url]: https://gitter.im/ethereum/web3.js
180
+ [lerna-image]: https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg
181
+ [lerna-url]: https://lerna.js.org/
182
+ [stackexchange-image]: https://img.shields.io/badge/web3js-stackexchange-brightgreen
183
+ [stackexchange-url]: https://ethereum.stackexchange.com/questions/tagged/web3js
0 commit comments