Merge f39f475 into 2346c49

.gitignore

@@ -31,4 +31,4 @@ yarn-error.log
 .DS_Store
 
 # env files
-.env*
+.env

README.md

@@ -2,29 +2,71 @@
 
 Boilerplate module written in typescript
 
-[![npm version](https://badge.fury.io/js/tree-house-boilerplate.svg)](https://badge.fury.io/js/tree-house-boilerplate)
-[![Dependencies](https://david-dm.org/icapps/tree-house-boilerplate.svg)](https://david-dm.org/icapps/tree-house-boilerplate.svg)
-[![Build Status](https://travis-ci.org/icapps/tree-house-boilerplate.svg?branch=master)](https://travis-ci.org/icapps/tree-house-boilerplate)
-[![Coverage Status](https://coveralls.io/repos/github/icapps/tree-house-boilerplate/badge.svg)](https://coveralls.io/github/icapps/tree-house-boilerplate) [![Greenkeeper badge](https://badges.greenkeeper.io/icapps/tree-house-communication.svg)](https://greenkeeper.io/)
+[![npm version](https://badge.fury.io/js/tree-house-communication.svg)](https://badge.fury.io/js/tree-house-communication)
+[![Dependencies](https://david-dm.org/icapps/tree-house-communication.svg)](https://david-dm.org/icapps/tree-house-communication.svg)
+[![Build Status](https://travis-ci.org/icapps/tree-house-communication.svg?branch=master)](https://travis-ci.org/icapps/tree-house-communication)
+[![Coverage Status](https://coveralls.io/repos/github/icapps/tree-house-communication/badge.svg)](https://coveralls.io/github/icapps/tree-house-communication)
 
-## Usage
+## General
+
+This module is used to send emails with Mandrill and only template requests (for now).
+
+## Installation
 
 ```shell
-Clone this project
+npm install tree-house-communication
 ```
 
-```shell
-Copy code to new git project, commit and start making your new module
+## Usage example
+
+```javascript
+import * as emailService from 'tree-house-communication'
+
+// set Mandrill API key
+emailService.setMandrillApiKey('secretMandrillKey')
+
+// Create email(s)
+const mailInfo : ITemplateRequest = {
+  templateName: 'icapps-newsletter-template',
+  subject: 'My subject',
+  from: { email: 'info@icapps.be', name: 'Info icapps' },
+  to: [{ email: 'testAddress@gmail.com', name: 'Optional',
+    content: [{ name: 'greeting', value: 'Hello test!' }] }],
+  globalContent: [{ name: 'news', value: 'content of big news' }],
+};
+
+const extraMandrillOptions = {
+    async: true,
+    message: { bcc_address: 'test@gmail.com' }
+    }
+
+// Send email(s)
+const result = await sendEmailWithTemplate(mailInfo, extraMandrillOptions);
+
+// example result
+[
+  {
+    email: 'email@mail.com',
+    status: 'queued',
+    _id: 'e8b9d10ea47e47629d95b22fe200389d'
+  }, {
+    email: 'anotherEmail@mail.com',
+    status: 'queued',
+    _id: '308274f983f14eb09d266dd9abe51546'
+  }
+]
 ```
 
+See all [extraMandrillOptions](https://mandrillapp.com/api/docs/messages.JSON.html#method=send-template)
+
 ## Tests
 
-  You can run `npm run test` to run all tests
-  You can run `npm run test:coverage` to run all tests with coverage report
+- You can run `npm run test` to run all tests
+- You can run `npm run test:coverage` to run all tests with coverage report
 
 ## Authors
 
-See the list of [contributors](https://github.com/icapps/tree-house-boilerplate/contributors) who participated in this project.
+See the list of [contributors](https://github.com/icapps/tree-house-communication/contributors) who participated in this project.
 
 ## License