README.md

# FermoSlugger

Generate slugs for URLs, based on an id and text.

## Installation

The package can be installed
by adding `fermo_slugger` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:fermo_slugger, "~> 0.8.4"}
  ]
end
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/fermo_slugger](https://hexdocs.pm/fermo_slugger).