README.md

# QuickFSPublicAPI Elixir Client

This Repository includes the source code for a auto-generated Elixir Client / SDK to call the quickfs.net API.

### Building

To install the required dependencies and to build the elixir project, run:
```
mix local.hex --force
mix do deps.get, compile
```

## Installation

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

```elixir
def deps do
  [{:quick_fs_public_api, "~> 0.1.0"}]
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/quick_fs_public_api](https://hexdocs.pm/quick_fs_public_api).