aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRawane Zossou <dev@raw1z.fr>2015-09-19 04:16:25 +0200
committerRawane Zossou <dev@raw1z.fr>2015-09-19 04:16:25 +0200
commit691d286313961598b86a1801bba8d3b10e23dca6 (patch)
tree4c5e9a70e76b5b9effa3d6a5c410540dac7024ea /README.md
parent8b77bf7207380748ba0370715b3123afff42aba7 (diff)
downloadmailchimp-691d286313961598b86a1801bba8d3b10e23dca6.tar.gz
mailchimp-691d286313961598b86a1801bba8d3b10e23dca6.tar.xz
update the readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 5 insertions, 16 deletions
diff --git a/README.md b/README.md
index a713b54..b07b0d6 100644
--- a/README.md
+++ b/README.md
@@ -21,27 +21,16 @@ def application do
end
```
-## Usage
+## API
-1. Put your API key in your *config.exs* file:
+Put your API key in your *config.exs* file:
```elixir
config :mailchimp,
apikey: "your api-us10"
```
+For now Mailchimp only supports HTTP Basic Auth.
-2. Start a new process:
+## Documentation
- Mailchimp.start_link
-
-### Getting Account Details
-
- Mailchimp.get_account_details()
-
-### Getting All Lists
-
- Mailchimp.get_all_lists()
-
-### Adding a Member to a List
-
- Mailchimp.add_member("list_id", "e-mail")
+TODO