# TorngenElixirClient
An [Torn API v2](https://www.torn.com/swagger/index.html) client generated by [Tornium/torngen](https://github.com/Tornium/torngen).

This library is intended to be installed as part of [Tornium/tornex](https://github.com/Tornium/tornex), but can be used without tornex.

## Installation
This library can be installed by adding `:torngen_elixir_client` to your list of dependencies in `mix.exs`:
```elixir
def deps do
  [
    {:torngen_elixir_client, ">= 1.0.0"}
  ]
end
```

For latest changes, you can also install the library directly from [GitHub](https://github.com/Tornium/torngen_elixir_client):
```elixir
def deps do
  [
    {:torngen_elixir_client, github: "Tornium/torngen_elixir_client"}
  ]
end
```

To install a specific version of the client, see [`mix help deps`](https://hexdocs.pm/mix/main/Mix.Tasks.Deps.html).

## Documentation
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) and can be found at <https://hexdocs.pm/torngen_elixir_client>.

For an example on using `torngen_elixir_client`, see the documentation for [Tornium/tornex](https://hexdocs.pm/tornex).

## Code Generation
The `torngen_elixir_client` repository is updated automatically as Torn updates the [OpenAPI specification](https://www.torn.com/swagger/index.html) through PRs that need to be manually merged. As such, there will sometimes be a delay between API specification changes and changes to `torngen_elixir_client`. You can also regenerate your own instance of the `torngen_elixir_client` through [torngen](https://github.com/Tornium/torngen).

**NOTE:** See the GPLv3 license exception in the [README](https://github.com/Tornium/torngen/blob/master/README.md#license) of `torngen` for information on the license of regenerating `torngen_elixir_client`.