Skip to main content

README.md

# Slugly

A tiny library for turning strings into URL-friendly slugs.

## Installation

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

```elixir
def deps do
  [
    {:slugly, "~> 0.1.0"}
  ]
end
```

## Usage

```elixir
iex> Slugly.slug("Hello, World!")
"hello-world"

iex> Slugly.slug("Café Déjà Vu")
"cafe-deja-vu"
```

Docs can be found at <https://hexdocs.pm/slugly>.