Mnemonic Slugs v0.0.3 MnemonicSlugs.Generator

Functions to generate mnemonic slugs by joining carefully selected words with a separator, currently - (a dash).

Summary

Returns a default length (two word) slug

Returns a slug count words long

generate_slug()

generate_slug() :: String.t

Returns a default length (two word) slug.

iex> MnemonicSlugs.Generator.generate_slug
"aurora-bermuda"

generate_slug(count)

generate_slug(count :: Integer.t) :: String.t

Returns a slug count words long.

iex> MnemonicSlugs.Generator.generate_slug(10)
"karate-textile-jungle-patrol-veteran-clone-nerve-stone-soviet-sting"