add mixin docs

socketio · Sep 6, 2012 · 5d25dd6 · 5d25dd6
1 parent 88fb716
commit 5d25dd6
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/Readme.md b/Readme.md
@@ -9,6 +9,18 @@ $ component install component/emitter
 ```
 
 ## API
+
+### Emitter(obj)
+
+  The `Emitter` may also be used as a mixin. For example
+  a "plain" object may become an emitter, or you may
+  extend an existing prototype:
+
+```js
+var obj = {};
+Emitter(obj);
+Emitter(User.prototype);
+```
 
 ### Emitter#on(event, fn)