extend-me - npm Package Compare versions

Comparing version 2.2.0 to 2.2.1

index.js

@@ -141,3 +141,3 @@ 'use strict';
             recur(proto);
-            if (proto.initialize) {
+            if (proto.hasOwnProperty('initialize')) {
                 proto.initialize.apply(term, args);
@@ -144,0 +144,0 @@ }

package.json

 {
   "name": "extend-me",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "main": "index.js",
@@ -23,2 +23,4 @@ "description": "Yet another Backbone-like class extender",
     "gulp-rename": "^1.2.2",
+    "gulp-replace": "^0.5.4",
+    "gulp-uglify": "^1.5.1",
     "jsdoc": "^3.3.3",
@@ -25,0 +27,0 @@ "run-sequence": "^1.1.4",

README.md

@@ -6,5 +6,33 @@ # extend-me
 
+Node.js:
+
 ```javascript
 var Base = require('extend-me').Base;
+```
 
+Browser:
+
+```html
+<script src="http://joneit.github.io/extend-me/extend-me.min.js"></script>
+```
+
+Usage:
+
+```javascript
+var MyClass = Base.extend({
+    initialize: function () { ... },
+    member1: ...,
+    member2: ...
+};
+
+var MyChildClass = MyClass.extend({
+    initialize: function () { /* called after base class's initialize() */ },
+    member1: ..., // overrides base class's definition of member1
+    member3: ...
+};
+```
+
+## Example
+
+```javascript
 var Parabola = Base.extend({
@@ -54,9 +82,20 @@ initialize: function (a, b) {
 
-## API documentation
+### API documentation
 
-Detailed API docs can be found [here](http://openfin.github.io/extend-me/extend-me.html).
+Detailed API docs can be found [here](http://joneit.github.io/extend-me/extend-me.html).
 
-## Regarding the git submodule `jsdoc-template`
+### Demo
 
+A demo can be found [here](http://joneit.github.io/extend-me/demo.html).
+
+### CDN versions
+
+To use in a browser, you have two options:
+
+1. Incorporate the node module into your own browserified project.
+2. Use the browserified versions [`extend-me.js`](http://joneit.github.io/extend-me/extend-me.js) or [`extend-me.min.js`](http://joneit.github.io/extend-me/extend-me.min.js) available on the Github pages CDN.
+
+### Submodules
+
 See the note [Regarding submodules](https://github.com/openfin/rectangular#regarding-submodules)
 for important information on cloning this repo or re-purposing its build template.

No alert changes

Improved metrics

Total package byte prevSize

11886

increased by8.55%

Number of lines in readme file

100

increased by63.93%

Worsened metrics

Dev dependency count

12

increased by20%

No dependency changes