hightower-naming 0.1.4

Generate random names with epic adjectives and nouns
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

# hightower-naming

Generate random hightower-style names with adjectives and nouns.

## Installation

Add this to your `Cargo.toml`:

```toml
[dependencies]
hightower-naming = "0.1.4"
```

## Usage

### Basic Usage

```rust
use hightower_naming::generate_random_name;

fn main() {
    // Generate name without random suffix
    let name = generate_random_name(None);
    println!("{}", name);
    // Example output: legendary-dragon

    // Generate name with 5 character random suffix
    let name = generate_random_name(Some(5));
    println!("{}", name);
    // Example output: legendary-dragon-79642

    // Generate name with custom suffix length
    let name = generate_random_name(Some(10));
    println!("{}", name);
    // Example output: legendary-dragon-3928574062
}
```

### With Custom Prefix

```rust
use hightower_naming::generate_random_name_with_prefix;

fn main() {
    // Generate name with custom prefix
    let name = generate_random_name_with_prefix(Some("app"), None);
    println!("{}", name);
    // Example output: app-legendary-dragon

    // Generate name with custom prefix and random suffix
    let name = generate_random_name_with_prefix(Some("app"), Some(5));
    println!("{}", name);
    // Example output: app-legendary-dragon-79642
}
```

## Name Format

Generated names follow the format:
- Without prefix: `{adjective}-{noun}[-{random}]`
- With prefix: `{prefix}-{adjective}-{noun}[-{random}]`

- **Prefix**: Optional custom prefix (default: none)
- **Adjective**: Random adjective (e.g., "alpha", "legendary", "unstoppable")
- **Noun**: Random noun (e.g., "warrior", "titan", "phoenix")
- **Random suffix**: Optional numeric string

## Examples

Run examples with:
```bash
cargo run --example basic
cargo run --example with_random_suffix
cargo run --example custom_suffix_length
cargo run --example with_prefix
```

Example outputs:
- `legendary-dragon` (no suffix, no prefix)
- `legendary-dragon-39285` (5 character suffix)
- `unstoppable-titan-1234567890` (10 character suffix)
- `app-supreme-phoenix` (custom prefix, no suffix)
- `app-alpha-warrior-74629` (custom prefix with 5 character suffix)