diff --git a/README.md b/README.md index c0eb834..3ae3282 100644 --- a/README.md +++ b/README.md @@ -16,41 +16,36 @@ When a checksum is invalid, warn the user that the phrase is not something gener However, there should be other checks in place, such as checking to make sure the user is inputting 12 words or more separated by a space. ie. `phrase.trim().split(/\s+/g).length >= 12` -## Usage -`npm install bip39` - -```javascript -var bip39 = require('bip39') - -var mnemonic = bip39.entropyToMnemonic('133755ff') // hex input, defaults to BIP39 English word list -// 'basket rival lemon' - - -bip39.mnemonicToEntropy(mnemonic) // hex input, defaults to BIP39 English word list -// '133755ff' - -// Generate a random mnemonic using crypto.randomBytes -mnemonic = bip39.generateMnemonic() // strength defaults to 128 bits -// 'seed sock milk update focus rotate barely fade car face mechanic mercy' +## Examples +``` js +// Generate a random mnemonic (uses crypto.randomBytes under the hood), defaults to 128-bits of entropy +var mnemonic = bip39.generateMnemonic() +// => 'seed sock milk update focus rotate barely fade car face mechanic mercy' bip39.mnemonicToSeedHex('basket actual') -// '5cf2d4a8b0355e90295bdfc565a022a409af063d5365bb57bf74d9528f494bfa4400f53d8349b80fdae44082d7f9541e1dba2b003bcfec9d0d53781ca676651f' +// => '5cf2d4a8b0355e90295bdfc565a022a409af063d5365bb57bf74d9528f494bfa4400f53d8349b80fdae44082d7f9541e1dba2b003bcfec9d0d53781ca676651f' bip39.mnemonicToSeed('basket actual') -// +// => bip39.validateMnemonic(mnemonic) -// true +// => true bip39.validateMnemonic('basket actual') -// false +// => false ``` -### Browser -Compile `bip39.js` with the following command: +``` js +var bip39 = require('bip39') - $ npm run compile +// defaults to BIP39 English word list +// uses HEX strings for entropy +var mnemonic = bip39.entropyToMnemonic('133755ff') +// => basket rival lemon -After loading this file in your browser, you will be able to use the global `bip39` object. +// reversible +bip39.mnemonicToEntropy(mnemonic) +// => '133755ff' +```