Skip to content

Commit eb0b512

Browse files
committed
Rework README a bit, adding a note about BIP39 algorithm and showing example passphrases using some of the different available wordlists.
1 parent c573796 commit eb0b512

File tree

1 file changed

+42
-14
lines changed

1 file changed

+42
-14
lines changed

crates/pgen/README.md

Lines changed: 42 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,29 +17,47 @@ randomly selected from the autocomplete-optimized wordlist. Be sure to
1717
[read the article][EFFWL] to learn about the difference between the
1818
different wordlists provided by the EFF.
1919

20-
These are some examples of generated passphrases:
20+
## Table of Contents
2121

22-
* gimmick saffron nirvana superstore voicemail dedicate guacamole oftentimes dwindling kingdom shuttle upright
23-
* bobcat pulley yearbook nectar krypton pesticide relic sauna detergent amnesty dishcloth tapestry
24-
* porcupine identical occupation oxidize avalanche celery vaporizer dastardly vicinity enlarged hatchling urethane
22+
* [Examples of generated passphrases](#examples-of-generated-passphrases)
23+
* [Usage](#usage)
24+
- [Options and arguments](#options-and-arguments)
25+
* [How many bits of entropy does your passphrase need?](#how-many-bits-of-entropy-does-your-passphrase-need)
26+
* [Is a CSPRNG really needed here?](#is-a-csprng-really-needed-here)
27+
* [Installation](#installation)
28+
* [Latest version available](#latest-version-available)
29+
30+
## Examples of generated passphrases
2531

26-
Latest version:
32+
### Using the default wordlist
2733

2834
```zsh
29-
pgen --version
35+
pgen
3036
```
3137

32-
```text
33-
pgen 3.0.0-alpha.1
38+
> spyglass eruption sapphire wifeless thimble breath fossil thwarting sedative peroxide vagrancy earlobe
39+
40+
### Using the EFF long wordlist
41+
42+
```zsh
43+
pgen -w eff-long
3444
```
3545

36-
## Table of Contents
46+
> flashy tackle semifinal endowment trekker exhume citrus venus carload implant
3747
38-
* [Usage](#usage)
39-
- [Options and arguments](#options-and-arguments)
40-
* [How many bits of entropy does your passphrase need?](#how-many-bits-of-entropy-does-your-passphrase-need)
41-
* [Is a CSPRNG really needed here?](#is-a-csprng-really-needed-here)
42-
* [Installation](#installation)
48+
### Using BIP39 wordlist, and custom number of words
49+
50+
```zsh
51+
pgen -w bip39 -n 24
52+
```
53+
54+
> sword relief this any peanut uncle supreme month impose learn rose ramp double auction course mutual bench elder
55+
> unfair dizzy harbor use casino pledge
56+
57+
> [!NOTE]
58+
> In the current version, BIP39 wordlist is available but the BIP39 algorithm itself is not yet used.
59+
> In the upcoming `v3.0.0` release, the BIP39 algorithm will be implemented so that when you use
60+
> the BIP39 wordlist it will generate mnemonics that can be used for generation of valid Bitcoin wallets.
4361
4462
## Usage
4563

@@ -167,6 +185,16 @@ sense to use a CSPRNG.
167185
1. [Install Rust](https://www.rust-lang.org/en-US/install.html).
168186
2. Run `cargo install -f [email protected]`
169187

188+
## Latest version available
189+
190+
```zsh
191+
pgen --version
192+
```
193+
194+
```text
195+
pgen 3.0.0-alpha.1
196+
```
197+
170198
[EFFWL]: https://www.eff.org/deeplinks/2016/07/new-wordlists-random-passphrases
171199

172200
[BIP39]: https://en.bitcoin.it/wiki/BIP_0039

0 commit comments

Comments
 (0)