From 2b5aebf1e0c1dd77e399064fcf10c8a3484fccbe Mon Sep 17 00:00:00 2001 From: Isaac Yonemoto Date: Thu, 28 Sep 2023 09:41:40 -0500 Subject: [PATCH] Update README.md updates version and adds exonerate compilation message --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 71d9cc8..a2f98df 100644 --- a/README.md +++ b/README.md @@ -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: