-
Notifications
You must be signed in to change notification settings - Fork 1
/
doc.go
79 lines (78 loc) · 2.06 KB
/
doc.go
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
// Copyright (c) 2023 0x6flab
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
// http://www.apache.org/licenses/LICENSE-2.0
// Package namegenerator provides a simple way to generate random names.
//
// Example to generate general names:
//
// package main
//
// import (
//
// "fmt"
//
// "github.com/0x6flab/namegenerator"
//
// )
//
// func main() {
// generator := namegenerator.NewGenerator()
// name := generator.Generate()
// fmt.Println(name)
//
// names := generator.GenerateNames(10)
// fmt.Println(names)
//
// generator = namegenerator.NewGenerator().WithGender(namegenerator.Male)
// name = generator.Generate()
// fmt.Println(name)
//
// names = generator.GenerateNames(10)
// fmt.Println(names)
//
// generator = namegenerator.NewGenerator().WithGender(namegenerator.Female)
// name = generator.Generate()
// fmt.Println(name)
//
// names = generator.GenerateNames(10)
// fmt.Println(names)
//
// generator = namegenerator.NewGenerator().WithGender(namegenerator.NonBinary)
// name = generator.Generate()
// fmt.Println(name)
//
// names = generator.GenerateNames(10)
// fmt.Println(names)
//
// generator = namegenerator.NewGenerator().WithPrefix("Dr. ")
// name = generator.Generate()
// fmt.Println(name)
//
// names = generator.GenerateNames(10)
// fmt.Println(names)
//
// generator = namegenerator.NewGenerator().WithSuffix(" Jr.")
// name = generator.Generate()
// fmt.Println(name)
//
// names = generator.GenerateNames(10)
// fmt.Println(names)
//
// generator = namegenerator.NewGenerator().WithPrefix("Dr. ").WithSuffix(" Jr.")
// name = generator.Generate()
// fmt.Println(name)
//
// names = generator.GenerateNames(10)
// fmt.Println(names)
//
// generator = namegenerator.NewGenerator().WithGender(namegenerator.Male).WithPrefix("Dr. ").WithSuffix(" Jr.")
// name = generator.Generate()
// fmt.Println(name)
//
// names = generator.GenerateNames(10)
// fmt.Println(names)
// }
package namegenerator