README.md

# Spudnik

Spudnik is a sub domain generator that generates vegatable based domain names in the format "adjective-vegetable-number".

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `spudnik` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:spudnik, "~> 0.1.0"}
  ]
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/spudnik](https://hexdocs.pm/spudnik).