git.iko.soy/typeable/mandrill
on master help sign in
Added README
commit304852af0b74d4534ee110f9168341e5cb54193c authorAlfredo Di Napoli <alfredo.dinapoli@gmail.com> dateTue 19 Aug 2014, 09:11 (12 years ago) parent8613a49
1 file changed+23−2
README.md+23−2
README.md+23−2
@@ -2,11 +2,32 @@
22
33# Haskell Client for the Mandrill JSON API
44
5−This module implement a low-level, 1:1 API to the [Mandrill](http://mandrillapp.com)
6−transactional email service.
5+This module implement a low-level, 1:1 mapping API to
6+the [Mandrill](http://mandrillapp.com) transactional email service.
77
88# Supported API versions
99
1010* 1.0 (partially)
11+ - [Users call](https://mandrillapp.com/api/docs/users.JSON.html)
1112 - [Messages call](https://mandrillapp.com/api/docs/messages.JSON.html)
1213 + send
14+
15+# Testing online API
16+
17+To test the online API, first build the package with tests enabled:
18+
19+```
20+cabal install --enable-tests
21+```
22+
23+Then export an environment variable with your Mandrill **Test** token:
24+
25+```
26+export MANDRILL_API_KEY="YOURKEYGOESHERE"
27+```
28+
29+And finally execute the testsuite:
30+
31+```
32+cabal test
33+```