xdc-web/packages/web3-shh/README.md

XinFin JavaScript API wrapper repository

# web3-shh

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

This is the whisper v5 package.   
Please read the [documentation][docs] for more.

## Installation

### Node.js

```bash
npm install web3-shh
```

### In the Browser

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

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

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


## Usage

```js
// in node.js
var Web3Personal = require('web3-shh');

var shh = new Web3Personal('ws://localhost:8546');
```


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