Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 900 Bytes

README.md

File metadata and controls

35 lines (23 loc) · 900 Bytes

ImprovMX for Elixir Hex pm hex.pm downloads

An Elixir wrapper for the ImprovMX API

Installation

This package can be installed by adding improvmx to your list of dependencies in mix.exs:

def deps do
  [
    {:improvmx, "~> 0.1"}
  ]
end

Configuration

To make calls the API, it is necessary to configure your ImprovMX API key in your config.exs file:

config :improvmx, api_key: System.get_env("IMPROVMX_API_KEY")
# OR
config :improvmx, api_key: "YOUR_KEY"

You can generate this key sat https://app.improvmx.com/api

Documentation

The docs can be found at https://hexdocs.pm/improvmx.

License

More info at LICENSE.