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

Routine cleanup #3443

Merged
merged 6 commits into from
Mar 31, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .bowerrc

This file was deleted.

File renamed without changes.
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ npm-debug.log
/coverage
/tmp
node_modules
bower_components
/bower
.idea/
.npm/
.vscode/
Expand Down
2 changes: 0 additions & 2 deletions .versions

This file was deleted.

5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,11 @@ Released with 1.0.0-beta.37 code base.
### Changed

- Ensure '0x' prefix is existing for Accounts.sign and Accounts.privateKeyToAccount (#3041)
- Repository cleanup
- Removed old `docs/_build` folder
- Removed old bower and meteor artifacts
- Moved logo assets to own folder
- Moved github assets to own folder

### Fixed

Expand Down
63 changes: 32 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<p align="center">
<img src="https://github.com/ethereum/web3.js/raw/1.x/web3js.jpg" width=200 />
<img src="assets/logo/web3js.jpg" width="200" alt="web3.js" />
</p>

# web3.js - Ethereum JavaScript API

[![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]
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
[![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 Dependency Status][deps-dev-image]][deps-dev-url] [![Coverage Status][coveralls-image]][coveralls-url]
[![Lerna][lerna-image]][lerna-url]

This is the Ethereum [JavaScript API][docs]
which connects to the [Generic JSON RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC) spec.
which connects to the [Generic JSON-RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC) spec.

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

Expand All @@ -28,14 +28,6 @@ npm install web3
yarn add web3
```

### Meteor

_Note_: works only in the Browser for now. (PR welcome).

```bash
meteor add ethereum:web3
```

### In the Browser

Use the prebuild `dist/web3.min.js`, or
Expand All @@ -48,16 +40,18 @@ npm run-script build
Then include `dist/web3.js` in your html file.
This will expose `Web3` on the window object.

Or via jsDelivr CDN
Or via jsDelivr CDN:

```html
<script src="https://cdn.jsdelivr.net/npm/web3@latest/dist/web3.min.js"></script>
```
UNPKG

UNPKG:

```html
<script src="https://unpkg.com/web3@latest/dist/web3.min.js"></script>
```

## Usage

```js
Expand Down Expand Up @@ -110,7 +104,7 @@ If you are using the types in a `commonjs` module like for example a node app yo

## Documentation

Documentation can be found at [read the docs][docs].
Documentation can be found at [ReadTheDocs][docs].

## Building

Expand All @@ -127,7 +121,7 @@ sudo apt-get install npm

### Building (gulp)

Build only the web3.js package
Build only the web3.js package:

```bash
npm run-script build
Expand All @@ -153,30 +147,37 @@ The contribution guidelines are provided in [CONTRIBUTIONS](./CONTRIBUTIONS.md)

### Community

- [Gitter](https://gitter.im/ethereum/web3.js?source=orgpage)
- [Gitter][gitter-url]
- [StackExchange][stackexchange-url]
- [Forum](https://forum.ethereum.org/categories/ethereum-js)

### Similar libraries in other languages

- Python - [Web3.py](https://github.com/ethereum/web3.py)
- Haskell - [hs-web3](https://github.com/airalab/hs-web3)
- Java - [web3j](https://github.com/web3j/web3j)
- Scala - [web3j-scala](https://github.com/mslinn/web3j-scala)
- Purescript - [purescript-web3](https://github.com/f-o-a-m/purescript-web3)
- PHP - [web3.php](https://github.com/sc0Vu/web3.php)
- Ruby - [ethereum.rb](https://github.com/EthWorks/ethereum.rb)
- Haskell: [hs-web3](https://github.com/airalab/hs-web3)
- Java: [web3j](https://github.com/web3j/web3j)
- PHP: [web3.php](https://github.com/sc0Vu/web3.php)
- Purescript: [purescript-web3](https://github.com/f-o-a-m/purescript-web3)
- Python: [Web3.py](https://github.com/ethereum/web3.py)
- Ruby: [ethereum.rb](https://github.com/EthWorks/ethereum.rb)
- Scala: [web3j-scala](https://github.com/mslinn/web3j-scala)

[repo]: https://github.com/ethereum/web3.js
[docs]: http://web3js.readthedocs.io/
[npm-image]: https://badge.fury.io/js/web3.png
[npm-image]: https://img.shields.io/npm/dm/web3.svg
[npm-url]: https://npmjs.org/package/web3
[travis-image]: https://travis-ci.org/ethereum/web3.js.svg
[travis-url]: https://travis-ci.org/ethereum/web3.js
[dep-image]: https://david-dm.org/ethereum/web3.js.svg
[dep-url]: https://david-dm.org/ethereum/web3.js
[dep-dev-image]: https://david-dm.org/ethereum/web3.js/dev-status.svg
[dep-dev-url]: https://david-dm.org/ethereum/web3.js#info=devDependencies
[travis-image]: https://travis-ci.org/ethereum/web3.js.svg?branch=1.x
[travis-url]: https://travis-ci.org/ethereum/web3.js?branch=1.x
[deps-image]: https://david-dm.org/ethereum/web3.js/1.x/status.svg
[deps-url]: https://david-dm.org/ethereum/web3.js/1.x
[deps-dev-image]: https://david-dm.org/ethereum/web3.js/1.x/dev-status.svg
[deps-dev-url]: https://david-dm.org/ethereum/web3.js/1.x/#info=devDependencies
[coveralls-image]: https://coveralls.io/repos/ethereum/web3.js/badge.svg?branch=1.x
[coveralls-url]: https://coveralls.io/r/ethereum/web3.js?branch=1.x
[waffle-image]: https://badge.waffle.io/ethereum/web3.js.svg?label=ready&title=Ready
[waffle-url]: https://waffle.io/ethereum/web3.js
[gitter-image]: https://badges.gitter.im/Join%20Chat.svg
[gitter-url]: https://gitter.im/ethereum/web3.js
[lerna-image]: https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg
[lerna-url]: https://lerna.js.org/
[stackexchange-image]: https://img.shields.io/badge/web3js-stackexchange-brightgreen
[stackexchange-url]: https://ethereum.stackexchange.com/questions/tagged/web3js
File renamed without changes.
File renamed without changes
File renamed without changes
75 changes: 0 additions & 75 deletions bower.json

This file was deleted.

Binary file not shown.
Binary file removed docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file removed docs/_build/doctrees/getting-started.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/glossary.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/include_announcement.doctree
Binary file not shown.
Binary file not shown.
Binary file removed docs/_build/doctrees/include_package-net.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/web3-bzz.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/web3-eth-abi.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/web3-eth-accounts.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/web3-eth-contract.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/web3-eth-iban.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/web3-eth-net.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/web3-eth-personal.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/web3-eth-subscribe.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/web3-eth.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/web3-net.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/web3-shh.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/web3-utils.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/web3.doctree
Binary file not shown.
4 changes: 0 additions & 4 deletions docs/_build/html/.buildinfo

This file was deleted.

30 changes: 0 additions & 30 deletions docs/_build/html/_sources/callbacks-promises-events.txt

This file was deleted.

41 changes: 0 additions & 41 deletions docs/_build/html/_sources/getting-started.txt

This file was deleted.

Loading