README.md
# Islands State
A [`state`][state] struct and functions implementing a [state machine][fsm] for
the [Game of Islands][readme].
##### Based on the book [Functional Web Development](https://pragprog.com/book/lhelph/functional-web-development-with-elixir-otp-and-phoenix) by Lance Halvorsen.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `islands_state` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:islands_state, "~> 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/islands_state](https://hexdocs.pm/islands_state).
[fsm]: https://en.wikipedia.org/wiki/Finite-state_machine
[readme]: https://github.com/RaymondLoranger/islands_vue_client#readme
[state]: https://hexdocs.pm/islands_state/Islands.State.html#t:t/0