From f0b0c8f0fe3808824722fc0c8fb4396a2cc7d38c Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Fri, 25 Mar 2016 01:09:57 +0000 Subject: [PATCH] Describe provider-engine in the README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 4700c9a..aef4431 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,18 @@ Instance methods: * `deriveChild(index)` - derive a node based on a child index * `getWallet()` - return a `Wallet` instance as seen above +## Provider Engine + +The Wallet can be easily plugged into [provider-engine](https://github.com/metamask/provider-engine) to provide signing: + +```js +const WalletSubprovider = require('ethereumjs-wallet/provider-engine') + +.addProvider(new WalletSubprovider()) +``` + +Note it only supports the basic wallet. With a HD Wallet, call `getWallet()` first. + ### Remarks about `toV3` The `options` is an optional object hash, where all the serialization parameters can be fine tuned: