README.md

# Islands Engine

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

Models the Game of Islands.

##### Based on the book [Functional Web Development](https://pragprog.com/book/lhelph/functional-web-development-with-elixir-otp-and-phoenix) by Lance Halvorsen.

## Installation

Add the `:islands_engine` dependency to your `mix.exs` file:

```elixir
def deps do
  [
    {:islands_engine, "~> 0.1"}
  ]
end
```

## Note

Package [Islands Text Client](https://hex.pm/packages/islands_text_client) uses
`:islands_engine` as a dependency to play the Game of Islands in the console.