From f923e144eafc5d4a134377832816ba1b31eebc63 Mon Sep 17 00:00:00 2001
From: Johnny Estilles <johnny.estilles@agentia.asia>
Date: Mon, 22 Jun 2015 08:25:11 +0800
Subject: [PATCH] Add note to README regarding use of EventEmitter [skip ci]

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index 9122c72..fc6c2b1 100644
--- a/README.md
+++ b/README.md
@@ -111,6 +111,28 @@ option | description | default value
 `eventEmitter` | event emitter used by `response` object | `mockEventEmitter`
 `writableStream`  | writable stream used by `response` object | `mockWritableStream`
 
+> NOTE: The out-of-the-box mock event emitter included with `node-mocks-http` is
+not a functional event emitter and as such does not actually emit events. If you
+wish to test your event handlers you will need to bring your own event emitter.
+
+> Here's an example:
+
+```js
+var httpMocks = require('node-mocks-http');
+var res = httpMocks.createResponse({
+  EventEmitter: require('events').EventEmitter;
+});
+
+// ...
+  it('should do something', funciton(done) {
+    res.on('end', function() {
+      assert.equal(...);
+      done();
+    });
+  });
+// ...
+```
+
 ## Design Decisions
 
 We wanted some simple mocks without a large framework.