demoxdc/packages/web3-providers-ipc/README.md

Ethereum JavaScript API wrapper repository

# web3-providers-ipc

This is a sub package of [web3.js][repo]

This is a IPC provider for [web3.js][repo].   
Please read the [documentation][docs] for more.

## Installation

### Node.js

```bash
npm install web3-providers-ipc
```

### In the Browser

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

```bash
npm run-script build-all
```

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


## Usage

```js
// in node.js
var Web3IpcProvider = require('web3-providers-ipc');
var net = require(net);

var ipc = new Web3IpcProvider('/Users/me/Library/Ethereum/geth.ipc', net);
```


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