usage

kawanet · Jul 1, 2015 · 29fe8d1 · 29fe8d1
1 parent dead417
commit 29fe8d1
Showing 1 changed file with 64 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,64 @@
-# event-lite
-event-lite.js - Light-weight EventEmitter (less than 1KB when minified)
+# event-lite.js
+
+Light-weight EventEmitter (less than 1KB when minified)
+
+## Usage
+
+```js
+var EventLite = require("event-lite");
+
+function MyClass() {...}             // your class
+
+EventLite.mixin(MyClass.prototype);  // import event methods
+
+var obj = new MyClass();
+obj.on("foo", function() {...});     // add event listener
+obj.once("bar", function() {...});   // add one-time event listener
+obj.emit("foo");                     // dispatch event
+obj.emit("bar");                     // dispatch another event
+obj.off("foo");                      // remove event listener
+```
+
+## Node.js
+
+```sh
+npm install event-lite --save
+```
+
+## Browsers
+
+```html
+<script src="https://raw.githubusercontent.com/kawanet/event-lite/master/dist/event-lite.min.js"></script>
+```
+
+## Repository
+
+https://github.com/kawanet/event-lite
+
+## See Also
+
+- https://nodejs.org/api/events.html
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Yusuke Kawasaki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.