Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/ethereumProvider' into addMiss…
Browse files Browse the repository at this point in the history
…ingExports
  • Loading branch information
aalok05 committed Jan 16, 2019
2 parents b14a175 + 1ba3669 commit 046c556
Show file tree
Hide file tree
Showing 100 changed files with 645 additions and 10,126 deletions.
24 changes: 7 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,31 +73,21 @@ const web3 = new Web3("ws://localhost:8546");

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

## Building
## Contributing

### Requirements

* [Node.js](https://nodejs.org)
* npm

### Building

### Commands
```bash
npm run build // Bundle all modules

// Or
npm run clean // removes all the node_modules folders in all modules
npm run bootstrap // install all dependencies and symlinks the internal modules for all modules
npm run test // runs all tests
npm run build // runs rollup
npm run dev // runs rollup with a watcher

cd packages/web3-eth
npm run build // This will just bundle the web3-eth module

cd packages/web3-eth
npm run dev // This module will be bundled each time a file has changed
```

### Testing

```bash
npm run test
```

### Contributing
Expand Down
2 changes: 1 addition & 1 deletion lerna.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "1.0.0-beta.36",
"version": "1.0.0-beta.38",
"lerna": "2.0.0",
"command": {
"init": {
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "web3",
"namespace": "ethereum",
"version": "1.0.0-beta.36",
"version": "1.0.0-beta.38",
"description": "Ethereum JavaScript API wrapper repository",
"license": "LGPL-3.0",
"main": "./packages/web3/src/index.js",
Expand Down
23 changes: 3 additions & 20 deletions packages/web3-bzz/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,38 +6,21 @@ This is the swarm package of web3.js for further information please read the [do

## Installation

### Node.js

```bash
npm install web3-bzz
```

### In the Browser

Build running the following in the [web3.js][repo] repository:

```bash
npm run-script build-all
> npm install web3-bzz
```

Then include `dist/web3-bzz.js` in your html file.
This will expose the `Web3Bzz` object on the window object.


## Usage

```js
import {Bzz} from 'web3-bzz';

const bzz = new Bzz('http://swarm-gateways.net');
new Bzz('http://swarm-gateways.net');
```

## Types

If you are using TypeScript all the types are defined in the `index.d.ts` file

All the typescript typings are placed in the types folder.

[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js


Loading

0 comments on commit 046c556

Please sign in to comment.