README.md
# Islands Player ID
Defines the [`player ID`][player_id] type for the [Game of Islands][readme].
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `islands_player_id` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:islands_player_id, "~> 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_player_id](https://hexdocs.pm/islands_player_id).
[player_id]: https://hexdocs.pm/islands_player_id/Islands.PlayerID.html#t:t/0
[readme]: https://github.com/RaymondLoranger/islands_vue_client#readme