aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJean Duarte <jeancduarte@gmail.com>2016-02-16 15:59:04 -0200
committerJean Duarte <jeancduarte@gmail.com>2016-02-16 15:59:04 -0200
commit3c2680afe99f7b21adaf24c7c93ed89bce64ba52 (patch)
treede2587823b9ef9118b51da6cabf0def6deadec72 /README.md
parent4f7089134002a2eaf96be6d833a3134fb9918ab9 (diff)
downloadmailchimp-3c2680afe99f7b21adaf24c7c93ed89bce64ba52.tar.gz
mailchimp-3c2680afe99f7b21adaf24c7c93ed89bce64ba52.tar.xz
refatoring
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 16 insertions, 5 deletions
diff --git a/README.md b/README.md
index b07b0d6..83f14ae 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ First, add MailChimp lib to your `mix.exs` dependencies:
```elixir
def deps do
- [{:mailchimp, "~> 0.0.2"}]
+ [{:mailchimp, "~> 0.0.5"}]
end
```
@@ -21,7 +21,7 @@ def application do
end
```
-## API
+## Usage
Put your API key in your *config.exs* file:
@@ -29,8 +29,19 @@ Put your API key in your *config.exs* file:
config :mailchimp,
apikey: "your api-us10"
```
-For now Mailchimp only supports HTTP Basic Auth.
-## Documentation
+Start a new process:
-TODO
+ Mailchimp.start_link
+
+### Getting Account Details
+
+ Mailchimp.Account.get()
+
+### Getting All Lists
+
+ TODO
+
+### Adding a Member to a List
+
+ TODO