<p align="center">
  <img alt="Vuforex logo" width="200" src="https://s3.amazonaws.com/arpia.pro/images/arpia-logo-rounded.png">
</p>

# Vuforex [![elixir](https://github.com/rands0n/vuforex/actions/workflows/elixir.yml/badge.svg)](https://github.com/rands0n/vuforex/actions/workflows/elixir.yml)

**HTTP Client for Vuforia Web Services.**

## Installation

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

```elixir
def deps do
  [
    {:vuforex, "~> 0.1.2"}
  ]
end
```

## Development

We've included Docker, you can use with the command below:

```bash
docker-compose run --rm app iex -S mix
```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/rands0n/vuforex. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Vuforex project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rands0n/vuforex/blob/master/CODE_OF_CONDUCT.md).

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/vuforex](https://hexdocs.pm/vuforex).