README

A mnemonics generator for PHP 8.4+

Install

Via Composer

composer require owenvoke/mnemonics-php

Usage

Convert a string to a mnemonic

use OwenVoke\Mnemonics\Mnemonic;

$mnemonicGenerator = new Mnemonic(DefaultWordList::WORDS);
$mnemonicGenerator->toMnemonic('...');

Convert a mnemonic to a string

$mnemonicGenerator = new Mnemonic(DefaultWordList::WORDS);
$mnemonicGenerator->toEntropy(['...', '...']);

Using the make method

Mnemonic::make()->toMnemonic('...');

Change log

Please see GitHub Releases for more information on what has changed recently.

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email security@voke.dev instead of using the issue tracker.

Credits

• Owen Voke
• phpninjas
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Treeware

You're free to use this package, but if it makes it to your production environment you are required to buy the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you support this package and contribute to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees here.

Read more about Treeware at treeware.earth.