asteroids-listener - npm Package Compare versions

Comparing version 0.0.0 to 0.0.1

package.json

 {
   "name": "asteroids-listener",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Custom implementation of the observer pattern tailored for Asteroids",
@@ -5,0 +5,0 @@ "main": "lib/listener.js",

README.md

@@ -5,1 +5,55 @@ asteroids-listener
 Custom implementation of the observer pattern tailored for Asteroids
+
+
+Examples
+--------
+
+### Direct
+
+```javascript
+var Listener = require('asteroids-listener');
+
+var listener = new Listener();
+var identifier = listener.addListener('change', function(){
+    console.log('a change occured');
+})
+
+listener.notifyOf('change');
+
+listener.removeListener(identifier);
+
+listener.notifyOf('change');
+```
+
+Output:
+
+```
+a change occured
+```
+
+### Prototype
+
+```javascript
+var Listener = require('asteroids-listener');
+
+var Discussion = function(){
+    Listener.call(this);
+}
+Discussion.prototype = new Listener();
+Discussion.prototype.agreement = function(){
+    this.notifyOf('agreement');
+};
+
+var discussion = new Discussion();
+discussion.addListener('agreement', function Stakeholder(){
+    console.log('celebrating');
+})
+
+discussion.agreement();
+```
+
+Output:
+
+```
+celebrating
+```

No alert changes

Improved metrics

Total package byte prevSize

4887

19.69%

Number of lines in readme file

59

1080%

No dependency changes