README.md
# Estate
Defines a set of behavior on an ecto schema-enabled module that decorates it with state machine helpers.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `estate` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:estate, "~> 1.0.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/estate>.