This README is the one indexed from the repository at its latest ref, not from the tag for this version.

pgp-wordlist.cr

A simple library for converting sequences of bytes into unambiguous English words.

Uses the "official" word list: https://philzimmermann.com/docs/PGP_word_list.pdf

Installation

Add this to your application's shard.yml:

dependencies:
  pgp-wordlist:
    github: woodruffw/pgp-wordlist.cr

Usage

require "pgp-wordlist"

PGP::Wordlist.from_hexstring "0123 cdef" # => "absurd cannonball spindle unravel"

bytes = [0xfe_u8, 0xed_u8, 0xfa_u8, 0xce_u8]
PGP::Wordlist.from_bytes bytes # => "woodlark unify wallet sardonic"

Contributing

1. Fork it (https://github.com/woodruffw/pgp-wordlist.cr/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• woodruffw William Woodruff - creator, maintainer