Skip to content
This repository was archived by the owner on Mar 5, 2025. It is now read-only.

Commit f5f24a5

Browse files
committed
Move logo assets to own folder, organize README link
1 parent f1f18cc commit f5f24a5

File tree

5 files changed

+30
-16
lines changed

5 files changed

+30
-16
lines changed

CHANGELOG.md

+5
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,11 @@ Released with 1.0.0-beta.37 code base.
147147
### Changed
148148

149149
- Ensure '0x' prefix is existing for Accounts.sign and Accounts.privateKeyToAccount (#3041)
150+
- Repository cleanup
151+
- Removed unneeded `docs/_build` folder
152+
- Removed bower and meteor artifact files
153+
- Moved logo assets to own folder
154+
- Moved github assets to own folder
150155

151156
### Fixed
152157

README.md

+25-16
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<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">
33
</p>
44

55
# web3.js - Ethereum JavaScript API
66

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]
99

1010
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.
1212

1313
You need to run a local or remote [Ethereum](https://www.ethereum.org/) node to use this library.
1414

@@ -40,16 +40,18 @@ npm run-script build
4040
Then include `dist/web3.js` in your html file.
4141
This will expose `Web3` on the window object.
4242

43-
Or via jsDelivr CDN
43+
Or via jsDelivr CDN:
4444

4545
```html
4646
<script src="https://cdn.jsdelivr.net/npm/web3@latest/dist/web3.min.js"></script>
4747
```
48-
UNPKG
48+
49+
UNPKG:
4950

5051
```html
5152
<script src="https://unpkg.com/web3@latest/dist/web3.min.js"></script>
5253
```
54+
5355
## Usage
5456

5557
```js
@@ -102,7 +104,7 @@ If you are using the types in a `commonjs` module like for example a node app yo
102104
103105
## Documentation
104106
105-
Documentation can be found at [read the docs][docs].
107+
Documentation can be found at [ReadTheDocs][docs].
106108
107109
## Building
108110
@@ -119,7 +121,7 @@ sudo apt-get install npm
119121
120122
### Building (gulp)
121123
122-
Build only the web3.js package
124+
Build only the web3.js package:
123125
124126
```bash
125127
npm run-script build
@@ -145,7 +147,8 @@ The contribution guidelines are provided in [CONTRIBUTIONS](./CONTRIBUTIONS.md)
145147
146148
### Community
147149
148-
- [Gitter](https://gitter.im/ethereum/web3.js?source=orgpage)
150+
- [Gitter][gitter-url]
151+
- [StackExchange][stackexchange-url]
149152
- [Forum](https://forum.ethereum.org/categories/ethereum-js)
150153
151154
### Similar libraries in other languages
@@ -160,15 +163,21 @@ The contribution guidelines are provided in [CONTRIBUTIONS](./CONTRIBUTIONS.md)
160163
161164
[repo]: https://github.com/ethereum/web3.js
162165
[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
164167
[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
171174
[coveralls-image]: https://coveralls.io/repos/ethereum/web3.js/badge.svg?branch=1.x
172175
[coveralls-url]: https://coveralls.io/r/ethereum/web3.js?branch=1.x
173176
[waffle-image]: https://badge.waffle.io/ethereum/web3.js.svg?label=ready&title=Ready
174177
[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
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)