codenamegenerator

README

Code Name Generator

A Go package to generate a three-word code name for multi-purpose use. The package relies on codenamegenerator.com for generation as opposed to lengthy slices within the package.

The output is as follows: <string>-<string>-<string>.

Badges

Install

go get github.com/jmvbxx/codenamegenerator

Update

go get -u github.com/jmvbxx/codenamegenerator

Usage

package main

import (
	"fmt"
	"log"

	"github.com/jmvbxx/codenamegenerator"
)

func main() {
	cn, err := codenamegenerator.NameGenerate()
	if err != nil {
		log.Fatal(err)
	}
	fmt.Println(cn)
}

Example output

brussels-ankara-yowie

Documentation

Index

• Variables
• func NameGenerate() (string, error)

Variables

var (
	CommonCodeNames = []string{"animals", "apple", "birds", "bugs", "dogs", "fishes",
		"flowers", "metal", "microsoft", "snakes", "units", "unusual_animals", "us_cities",
		"us_counties", "us_state_capitals", "us_states", "world_capitals", "world_countries"}
)

Functions

func NameGenerate

func NameGenerate() (string, error)