File: README.md

package info (click to toggle)
golang-github-goombaio-namegenerator 0.0.2-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 156 kB
  • sloc: makefile: 62; sh: 32
file content (73 lines) | stat: -rw-r--r-- 2,316 bytes parent folder | download
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
# namegenerator

A random name generator (for projects, servers, cluster nodes, etc ...)
implementation in Golang.

## Badges

[![License][License-Image]][License-URL]
[![CircleCI Status][CircleCI-Image]][CircleCI-URL]
[![Coverage Report][Coverage-Image]][Coverage-URL]
[![Go Report Card][GoReportCard-Image]][GoReportCard-URL]
[![CII Best Practices][CII-Image]][CII-URL]
[![GoDoc][GoDoc-Image]][GoDoc-URL]

## Install

```bash
go get github.com/goombaio/namegenerator
```

You can also update an already installed version:

```bash
go get -u github.com/goombaio/namegenerator
```

## Example of use

```go
package main

import (
    "github.com/goombaio/namegenerator"
)

func main() {
    seed := time.Now().UTC().UnixNano()
    nameGenerator := namegenerator.NewNameGenerator(seed)

    name := nameGenerator.Generate()

    fmt.Println(name)
}
```

## License

Copyright (c) 2018 Goomba project Authors.

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

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

[License-Image]: https://img.shields.io/badge/License-Apache-blue.svg
[License-URL]: http://opensource.org/licenses/Apache
[CircleCI-Image]: https://circleci.com/gh/goombaio/namegenerator.svg?style=svg
[CircleCI-URL]: https://circleci.com/gh/goombaio/namegenerator
[Coverage-Image]: https://codecov.io/gh/goombaio/namegenerator/branch/master/graph/badge.svg
[Coverage-URL]: https://codecov.io/gh/goombaio/namegenerator
[GoReportCard-Image]: https://goreportcard.com/badge/github.com/goombaio/namegenerator
[GoReportCard-URL]: https://goreportcard.com/report/github.com/goombaio/namegenerator
[CII-Image]: https://bestpractices.coreinfrastructure.org/projects/2237/badge
[CII-URL]: https://bestpractices.coreinfrastructure.org/projects/2237
[GoDoc-Image]: https://godoc.org/github.com/goombaio/namegenerator?status.svg
[GoDoc-URL]: http://godoc.org/github.com/goombaio/namegenerator