# Shinkansen

**TODO: Add description**

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `shinkansen` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:shinkansen, "~> 0.2.1"}
  ]
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/shinkansen>.

## Release

- Bump version in `mix.exs`
- Bump version in `README.md` (this file, on the Installation section)
- Commit, add a tag matching the version with the v prefix (e.g: "v0.5.1"), and push.
- Run `mix hex.publish package` (ask to be added as a maintainer first).