README.md

# Hangman Dictionary

Dictionary for the _Hangman Game_. Returns a random word.

##### Based on the course [Elixir for Programmers](https://codestool.coding-gnome.com/courses/elixir-for-programmers) by Dave Thomas.

## Installation

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

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