Skip to content

Commit

Permalink
Rework README a bit, adding a note about BIP39 algorithm and showing …
Browse files Browse the repository at this point in the history
…example passphrases using some of the different available wordlists.
  • Loading branch information
ctsrc committed Nov 20, 2024
1 parent c573796 commit eb0b512
Showing 1 changed file with 42 additions and 14 deletions.
56 changes: 42 additions & 14 deletions crates/pgen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,47 @@ randomly selected from the autocomplete-optimized wordlist. Be sure to
[read the article][EFFWL] to learn about the difference between the
different wordlists provided by the EFF.

These are some examples of generated passphrases:
## Table of Contents

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

## Examples of generated passphrases

Latest version:
### Using the default wordlist

```zsh
pgen --version
pgen
```

```text
pgen 3.0.0-alpha.1
> spyglass eruption sapphire wifeless thimble breath fossil thwarting sedative peroxide vagrancy earlobe
### Using the EFF long wordlist

```zsh
pgen -w eff-long
```

## Table of Contents
> flashy tackle semifinal endowment trekker exhume citrus venus carload implant
* [Usage](#usage)
- [Options and arguments](#options-and-arguments)
* [How many bits of entropy does your passphrase need?](#how-many-bits-of-entropy-does-your-passphrase-need)
* [Is a CSPRNG really needed here?](#is-a-csprng-really-needed-here)
* [Installation](#installation)
### Using BIP39 wordlist, and custom number of words

```zsh
pgen -w bip39 -n 24
```

> sword relief this any peanut uncle supreme month impose learn rose ramp double auction course mutual bench elder
> unfair dizzy harbor use casino pledge
> [!NOTE]
> In the current version, BIP39 wordlist is available but the BIP39 algorithm itself is not yet used.
> In the upcoming `v3.0.0` release, the BIP39 algorithm will be implemented so that when you use
> the BIP39 wordlist it will generate mnemonics that can be used for generation of valid Bitcoin wallets.
## Usage

Expand Down Expand Up @@ -167,6 +185,16 @@ sense to use a CSPRNG.
1. [Install Rust](https://www.rust-lang.org/en-US/install.html).
2. Run `cargo install -f pgen@3.0.0-alpha.1`

## Latest version available

```zsh
pgen --version
```

```text
pgen 3.0.0-alpha.1
```

[EFFWL]: https://www.eff.org/deeplinks/2016/07/new-wordlists-random-passphrases

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

0 comments on commit eb0b512

Please sign in to comment.