README.md

# Navigator

[![Build Status](https://github.com/fremantle-industries/navigator/workflows/test/badge.svg?branch=main)](https://github.com/fremantle-industries/navigator/actions?query=workflow%3Atest)
[![hex.pm version](https://img.shields.io/hexpm/v/navigator.svg?style=flat)](https://hex.pm/packages/navigator)

Global navigation between multiple Phoenix endpoints

## Installation

Add the `navigator` package to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:navigator, "~> 0.0.2"}
  ]
end
```

## Authors

- Alex Kwiatkowski - alex+git@fremantle.io

## License

`navigator` is released under the [MIT license](./LICENSE)