aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMentor Ágil <mentoragil@gmail.com>2015-05-12 22:11:49 -0300
committerMentor Ágil <mentoragil@gmail.com>2015-05-12 22:11:49 -0300
commit765438c4c2c300f84364b978a0b199a0e69c4e80 (patch)
tree8641ea4d3910a28fa8c702ee057251ce2d751abe /README.md
downloadmailchimp-765438c4c2c300f84364b978a0b199a0e69c4e80.tar.gz
mailchimp-765438c4c2c300f84364b978a0b199a0e69c4e80.tar.xz
first commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b570016
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+This is a basic Elixir wrapper for version 3 of the MailChimp API.
+
+## Usage
+
+1. Put your API key in your *config.exs* file.
+
+2. Start a new process:
+
+
+ Mailchimp.start_link []
+
+### Getting Account Details
+
+ Mailchimp.get_account_details/0
+
+### Getting All Lists
+
+ Mailchimp.get_all_lists/0