# PetName

This is a module to assist you in generating cute names for your pet.

[![Build Status](https://travis-ci.org/reergymerej/pet_name.svg?branch=master)](https://travis-ci.org/reergymerej/pet_name)

## Installation

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

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