Skip to content

Commit

Permalink
README: updates to current API
Browse files Browse the repository at this point in the history
  • Loading branch information
dcousens committed Aug 17, 2014
1 parent 7d3f636 commit f14d875
Showing 1 changed file with 5 additions and 9 deletions.
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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'
```

Expand All @@ -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.

0 comments on commit f14d875

Please sign in to comment.