Skip to content
An Elixir library for generating memorable slugs.
Elixir
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
test
.gitignore
README.md
mix.exs
mix.lock

README.md

Mnemonic Slugs

Mnemonic Slugs is an Elixir library that generates easy to remember slugs. It uses a word list curated by Oren Tirosh. The original site and word list can be found here.

Installation

Add mnemonic_slugs to your list of dependencies in mix.exs:

def deps do
  [{:mnemonic_slugs, "~> 0.0.1"}]
end

and update your dependencies with mix deps.get.

Usage

You can generate slugs two ways:

  iex> MnemonicSlugs.generate_slug
  "aurora-bermuda"

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

Full Documentation is at HexDocs.

Something went wrong with that request. Please try again.