aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: b07b0d60235150ce66fe8c706edf556283551cb3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
[![Hex Version](http://img.shields.io/hexpm/v/mailchimp.svg)](https://hex.pm/packages/mailchimp)

This is a basic Elixir wrapper for version 3 of the MailChimp API.

## Installation

First, add MailChimp lib to your `mix.exs` dependencies:

```elixir
def deps do
  [{:mailchimp, "~> 0.0.2"}]
end
```

and run `$ mix deps.get`. Now, list the `:mailchimp` application as your
application dependency:

```elixir
def application do
  [applications: [:mailchimp]]
end
```

## API

Put your API key in your *config.exs* file:

```elixir
config :mailchimp,
  apikey: "your api-us10"
```
For now Mailchimp only supports HTTP Basic Auth.

## Documentation

TODO