aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMentor Ágil <mentoragil@gmail.com>2015-05-12 23:52:51 -0300
committerMentor Ágil <mentoragil@gmail.com>2015-05-12 23:52:51 -0300
commit68d6b62493e118667588a04260dac67a3ae4ad0b (patch)
tree2f2179456151cc60c6481b363c22186b7ff96d3b /README.md
parent765438c4c2c300f84364b978a0b199a0e69c4e80 (diff)
downloadmailchimp-68d6b62493e118667588a04260dac67a3ae4ad0b.tar.gz
mailchimp-68d6b62493e118667588a04260dac67a3ae4ad0b.tar.xz
added functions to manipulate lists
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 20 insertions, 1 deletions
diff --git a/README.md b/README.md
index b570016..c54e5e0 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,24 @@
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.1"}]
+end
+```
+
+and run `$ mix deps.get`. Now, list the `:mailchimp` application as your
+application dependency:
+
+```elixir
+def application do
+ [applications: [:mailchimp]]
+end
+```
+
## Usage
1. Put your API key in your *config.exs* file.
@@ -7,7 +26,7 @@ This is a basic Elixir wrapper for version 3 of the MailChimp API.
2. Start a new process:
- Mailchimp.start_link []
+ Mailchimp.start
### Getting Account Details