https://github.com/devshane/mnemonic_slugs

An Elixir library for generating memorable slugs.
https://github.com/devshane/mnemonic_slugs

elixir-library slugs

Last synced: about 1 month ago
JSON representation

An Elixir library for generating memorable slugs.

• Host: GitHub
• URL: https://github.com/devshane/mnemonic_slugs
• Owner: devshane
• Created: 2016-03-06T15:51:09.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2020-03-03T18:07:47.000Z (almost 5 years ago)
• Last Synced: 2024-10-01T16:22:03.501Z (2 months ago)
• Topics: elixir-library, slugs
• Language: Elixir
• Size: 14.6 KB
• Stars: 26
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - A memorable, mnemonic slug generator in Elixir. (HTTP)
• fucking-awesome-elixir - mnemonic_slugs - A memorable, mnemonic slug generator in Elixir. (HTTP)
• awesome-elixir - mnemonic_slugs - A memorable, mnemonic slug generator in Elixir. (HTTP)

README

        
# Mnemonic Slugs

Mnemonic Slugs is an Elixir library that generates easy to remember slugs. It 

uses a slightly enhanced word list curated by Oren Tirosh as part of his 

mnemonic encoding project.

A fork of the original project can be found [here](https://github.com/devshane/mnemonicode).

## Installation

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

```

def deps do

  [{:mnemonic_slugs, "~> 0.0.3"}]

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](https://hexdocs.pm/mnemonic_slugs/MnemonicSlugs.html) is at HexDocs.