README.md
# OpenAPICompiler
[![Hex docs](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/openapi_compiler)
![.github/workflows/elixir.yml](https://github.com/jshmrtn/openapi-compiler/workflows/.github/workflows/elixir.yml/badge.svg)
[![Coverage Status](https://coveralls.io/repos/github/jshmrtn/openapi-compiler/badge.svg?branch=master)](https://coveralls.io/github/jshmrtn/openapi-compiler?branch=master)
[![Hex.pm](https://img.shields.io/hexpm/dt/openapi_compiler.svg)](https://hex.pm/packages/openapi_compiler)
:warning: :warning: This library is incomplete and experimental! :warning: :warning:
Compile OpenApi 3.0 Elixir Client from JSON / Yaml.
Help to make this library more spec compliant is welcome in form of issues / PR's.
## Installation
The package can be installed by adding `openapi_compiler` to your list of dependencies
in `mix.exs`:
```elixir
def deps do
[
{:openapi_compiler, "~> 1.0-beta"}
]
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). The docs can be found at
[https://hexdocs.pm/openapi_compiler](https://hexdocs.pm/openapi_compiler).