mnemonic-generator 0.1.0

A library to generate Docker-like mnemonics.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# Mnemonic Generator

A lightweight Rust library for generating Docker-like mnemonics.

## Installation

Add the following to your `Cargo.toml`:

```toml
[dependencies]
mnemonic-generator = "0.1.0"
```

## Usage

### Basic Usage

```rust
use mnemonic_generator::MnemonicGenerator;

fn main() {
    // Create a generator with default words
    let generator = MnemonicGenerator::new();

    // Generate a mnemonic with default underscore separator
    match generator.generate() {
        Ok(mnemonic) => println!("Generated mnemonic: {}", mnemonic),
        Err(e) => eprintln!("Error: {}", e)
    }
}
```

### Custom Word Lists

```rust
use mnemonic_generator::MnemonicGenerator;

fn main() {
    // Create a generator with custom words
    let generator = MnemonicGenerator::with_words(
        vec!["amazing".to_string(), "legend".to_string()],
        vec!["jordan".to_string(), "larry".to_string()]
    );

    // Generate a mnemonic with a custom separator
    match generator.generate_with_separator("-") {
        Ok(mnemonic) => println!("Custom mnemonic: {}", mnemonic),
        Err(e) => eprintln!("Error: {}", e)
    }
}
```

## Error Handling

The library provides a `MnemonicError` enum to handle potential generation errors:

- `EmptyWordList`: Occurs when no words are available for generating a mnemonic

## License

[MIT License]