README.md

[![](https://img.shields.io/hexpm/v/wow_api_elix.svg?style=for-the-badge)](https://hex.pm/packages/wow_api_elix)
[![](https://img.shields.io/hexpm/l/wow_api_elix.svg?style=for-the-badge)](https://hex.pm/packages/wow_api_elix)


# World of Warcraft Blizzard API for Elixir
https://develop.battle.net/documentation/api-reference

## Current features
* Caching
* Mounts
* Pets
* Boss

## Coming soon
* Rest of the API

## Setting up
Set this up in your `config.exs`
```elixir
config :wow_api_elix, api_client_id: ""     # Client ID
config :wow_api_elix, api_secret_key: ""    # Client Secret
config :wow_api_elix, api_language: :en_US  # API language, see below for available languages.
config :wow_api_elix, api_region: :eu       # API region, see below for available regions.


# Available languages
[
  :en_US, # English
  :es_MX, # Spanish - Mexico
  :pt_BR, # Portuguese - Brazil
  :de_DE, # German
  :es_ES, # Spanish
  :fr_FR, # French
  :it_IT, # Italy
  :pt_PT, # Portuguese
  :ru_RU, # Russian
  :ko_KR, # Korean
  :zh_TW, # Taiwanese Mandarin
  :zh_CN  # Simplified Chinese
]

# Available regions
[
  :us,  # US
  :eu,  # Europe
  :kr,  # Korea
  :tw   # Taiwan
]
```


## Installation
The package is available at ![Hex](https://hex.pm/packages/wow_api_elix).

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