Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
updates version and adds exonerate compilation message
  • Loading branch information
ityonemo authored Sep 28, 2023
1 parent efd0721 commit 2b5aebf
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,21 @@ Elixir Routers from OpenAPI schemas

This package can be installed by adding `apical` to your list of dependencies in `mix.exs`:

Exonerate is a compile-time dependency. If you don't include this in your Mix.exs, there will
be unwanted compiler warnings.

```elixir
def deps do
[
{:apical, "~> 0.1.0"}
{:apical, "~> 0.2.1"},
{:exonerate, "~> 1.1.2", runtime: Mix.env() != :prod}
]
end
```

If you think you might need to recompile your router in production, remove the runtime option
on Exonerate.

## Basic use

For the following router module:
Expand Down

0 comments on commit 2b5aebf

Please sign in to comment.