status-im
/
bip39
mirror of https://github.com/status-im/bip39.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

README: updates to current API

This commit is contained in:
Daniel Cousens 2014-08-17 11:18:53 +10:00
parent 7d3f636c36
commit f14d8757f1
1 changed files with 5 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,4 +1,4 @@
bip39
BIP39
=====
JavaScript implementation of [Bitcoin BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki): Mnemonic code for generating deterministic keys
@ -8,19 +8,16 @@ JavaScript implementation of [Bitcoin BIP39](https://github.com/bitcoin/bips/blo
`npm install bip39`
```javascript
var BIP39 = require('bip39')
var BIP39 = require('BIP39')
// defaults to BIP39 English word list
var bip39 = new BIP39()
var mnemonic = bip39.entropyToMnemonic('1337') // hex input, defaults to BIP39 English word list
var mnemonic = BIP39.entropyToMnemonic('1337') // hex input, defaults to BIP39 English word list
// 'basket actual'
// or
mnemonic = bip39.generateMnemonic() // strength defaults to 128 bits
mnemonic = BIP39.generateMnemonic() // strength defaults to 128 bits
// 'seed sock milk update focus rotate barely fade car face mechanic mercy'
bip39.mnemonicToSeedHex('basket actual') // wait for it...
BIP39.mnemonicToSeedHex('basket actual') // wait for it...
// '5cf2d4a8b0355e90295bdfc565a022a409af063d5365bb57bf74d9528f494bfa4400f53d8349b80fdae44082d7f9541e1dba2b003bcfec9d0d53781ca676651f'
```
@ -31,4 +28,3 @@ Compile `bip39.js` with the following command:
$ npm run compile
After loading this file in your browser, you will be able to use the global `BIP39` object.