Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme and refs on package.json #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# truffle-hdwallet-provider
# knowledge-hdwallet-provider
HD Wallet-enabled Web3 provider. Use it to sign transactions for addresses derived from a 12-word mnemonic.

## Install

```
$ npm install @knowledgeio/truffle-hdwallet-provider
$ npm install @knowledgeio/knowledge-hdwallet-provider
```

## General Usage

You can use this provider wherever a Web3 provider is needed, not just in Truffle. For Truffle-specific usage, see next section.

```javascript
var HDWalletProvider = require("truffle-hdwallet-provider");
var HDWalletProvider = require("@knowledgeio/knowledge-hdwallet-provider");
var mnemonic = "opinion destroy betray ..."; // 12 word mnemonic
var provider = new HDWalletProvider(mnemonic, "http://localhost:8545");

Expand All @@ -34,7 +34,7 @@ You can easily use this within a Truffle configuration. For instance:

truffle.js
```javascript
var HDWalletProvider = require("truffle-hdwallet-provider");
var HDWalletProvider = require("@knowledgeio/knowledge-hdwallet-provider");

var mnemonic = "opinion destroy betray ...";

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "@knowledgeio/knowledge-hdwallet-provider",
"version": "1.0.0",
"version": "1.0.1",
"description": "HD Wallet-enabled Web3 provider",
"main": "index.js",
"repository": {
"type": "git",
"url": "git+https://github.com/knowledge/truffle-hdwallet-provider.git"
"url": "git+https://github.com/knowledge/knowledge-hdwallet-provider.git"
},
"author": "Tim Coulter <[email protected]>",
"license": "MIT",
Expand Down