Skip to content

Commit 7d74a95

Browse files
committed
Fix readme and update license to match LICENSE file
1 parent bdfd9e4 commit 7d74a95

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,26 @@
33

44
[![NPM](https://img.shields.io/npm/v/bip32.svg)](https://www.npmjs.org/package/bip32)
55

6-
[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
6+
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
77

8-
A [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) compatible library.
8+
A [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) compatible library written in TypeScript with transpiled JavaScript committed to git.
99

1010

1111
## Example
12+
13+
TypeScript
14+
15+
``` typescript
16+
import * as bip32 from 'bip32';
17+
import { BIP32Interface } from 'bip32';
18+
let node: BIP32Interface = bip32.fromBase58('xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi');
19+
20+
let child: BIP32Interface = node.derivePath('m/0/0');
21+
// ...
22+
```
23+
24+
NodeJS
25+
1226
``` javascript
1327
let bip32 = require('bip32')
1428
let node = bip32.fromBase58('xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHi')

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
"typescript": "3.3.3333"
5454
},
5555
"author": "Daniel Cousens",
56-
"license": "ISC",
56+
"license": "MIT",
5757
"bugs": {
5858
"url": "https://github.com/bitcoinjs/bip32/issues"
5959
}

0 commit comments

Comments
 (0)