proper UMD bundling

README.md

@@ -1,7 +1,7 @@
 # | quadtree-lib | [![Build Status](https://travis-ci.org/elbywan/quadtree-lib.svg?branch=master)](https://travis-ci.org/elbywan/quadtree-lib) | [![Coverage Status](https://coveralls.io/repos/github/elbywan/quadtree-lib/badge.svg?branch=master)](https://coveralls.io/github/elbywan/quadtree-lib?branch=master) | [![npm version](https://badge.fury.io/js/quadtree-lib.svg)](https://www.npmjs.com/package/quadtree-lib)
 
 <a href="http://elbywan.github.io/quadtree-lib/demo/collisions/collisions.html" target="_blank">
-    <img alt="quatree gif" src="assets/quadtree.gif" width="150px" align="left" style="margin-right: 25px"/>
+    <img alt="quatree gif" src="http://elbywan.github.io/quadtree-lib/assets/quadtree.gif" width="150px" align="left" style="margin-right: 25px"/>
 </a>
 
 Quadtree-lib is an easy to use, developer friendly quadtree library which
@@ -27,18 +27,6 @@ From the command line :
 
 `npm install quadtree-lib` or `yarn add quadtree-lib`
 
-Then :
-
-```javascript
-Quadtree = require("quadtree-lib")
-```
-
-Or eventually :
-
-```html
-<script src="path/to/quadtree-lib.min.js"></script>
-```
-
 ### Using Bower
 
 `bower install quadtree-lib`
@@ -63,6 +51,22 @@ gulp perf
 
 ## Usage
 
+### Import
+
+**This library is bundled in UMD format.**
+
+Examples :
+
+- Import using commonjs :
+```javascript
+Quadtree = require("quadtree-lib")
+```
+
+- Import globally with a script tag :
+```html
+<script src="path/to/quadtree-lib.min.js"></script>
+```
+
 ### Init
 
 First step is to initialize a new Quadtree object.

docs/index.html

@@ -27,7 +27,25 @@ <h1 id="quadtree-lib">quadtree-lib</h1>
         <p><strong>Quadtree-lib</strong> is an easy to use, developer friendly quadtree library
 which contains many helper methods to add, remove, iterate, filter, simulate
 collisions over 2d elements and more.</p>
-<h2 id="the-quadtree-class-">The Quadtree class.</h2>
+
+
+
+
+        <h4 id="umd-bundling-related-code">UMD bundling related code</h4>
+
+
+          <div class='highlight'><pre>(<span class="hljs-function"><span class="hljs-params">(root, factory)</span> -&gt;</span>
+    <span class="hljs-keyword">if</span> <span class="hljs-keyword">typeof</span> define <span class="hljs-keyword">is</span> <span class="hljs-string">'function'</span> <span class="hljs-keyword">and</span> define.amd
+        define [], factory
+    <span class="hljs-keyword">else</span> <span class="hljs-keyword">if</span> <span class="hljs-keyword">typeof</span> exports <span class="hljs-keyword">is</span> <span class="hljs-string">'object'</span> <span class="hljs-keyword">and</span> <span class="hljs-built_in">module</span>.exports
+        <span class="hljs-built_in">module</span>.exports = factory()
+    <span class="hljs-keyword">else</span>
+        root[<span class="hljs-string">"Quadtree"</span>] = factory()
+) @, <span class="hljs-function"><span class="hljs-params">()</span> -&gt;</span></pre></div>
+
+
+
+        <h2 id="the-quadtree-class">The Quadtree class</h2>
 
 
 
@@ -43,11 +61,11 @@ <h3 id="constructor">Constructor</h3>
 
 
 
-        <p>A quadtree constructor has 5 parameters :</p>
+        <p>The quadtree constructor accepts a single parameter object containing the following properties :</p>
 <ul>
-<li>x &amp; y coordinates which are always (0, 0) for the root tree.</li>
-<li>its dimensions (width &amp; length), mandatory.</li>
-<li>the maximum number of elements before the leaf ‘splits’ into subtrees. (defaults to 1)</li>
+<li>width / length : dimensions of the quadtree. [ <em>mandatory</em> ]</li>
+<li>maxElements : the maximum number of elements before the leaf ‘splits’ into subtrees. [ <em>defaults to 1</em> ]</li>
+<li>x / y : these coordinates are used internally by the library to position subtrees. [ <em>internal use only</em> ]</li>
 </ul>
 
 
@@ -487,7 +505,7 @@ <h3 id="exposed-methods">Exposed methods</h3>
 
 
 
-        <p>Opposite of filter</p>
+        <p>Opposite of filter.</p>
 
 
           <div class='highlight'><pre>    reject: <span class="hljs-function"><span class="hljs-params">(predicate)</span> -&gt;</span>
@@ -555,13 +573,6 @@ <h3 id="exposed-methods">Exposed methods</h3>
         str</pre></div>
 
 
-
-        <p>Require export.</p>
-
-
-          <div class='highlight'><pre><span class="hljs-built_in">module</span>?.exports = Quadtree</pre></div>
-
-
       <div class="fleur">h</div>
     </div>
   </div>

docs/quadtree.html

@@ -27,7 +27,25 @@ <h1 id="quadtree-lib">quadtree-lib</h1>
         <p><strong>Quadtree-lib</strong> is an easy to use, developer friendly quadtree library
 which contains many helper methods to add, remove, iterate, filter, simulate
 collisions over 2d elements and more.</p>
-<h2 id="the-quadtree-class-">The Quadtree class.</h2>
+
+
+
+
+        <h4 id="umd-bundling-related-code">UMD bundling related code</h4>
+
+
+          <div class='highlight'><pre>(<span class="hljs-function"><span class="hljs-params">(root, factory)</span> -&gt;</span>
+    <span class="hljs-keyword">if</span> <span class="hljs-keyword">typeof</span> define <span class="hljs-keyword">is</span> <span class="hljs-string">'function'</span> <span class="hljs-keyword">and</span> define.amd
+        define [], factory
+    <span class="hljs-keyword">else</span> <span class="hljs-keyword">if</span> <span class="hljs-keyword">typeof</span> exports <span class="hljs-keyword">is</span> <span class="hljs-string">'object'</span> <span class="hljs-keyword">and</span> <span class="hljs-built_in">module</span>.exports
+        <span class="hljs-built_in">module</span>.exports = factory()
+    <span class="hljs-keyword">else</span>
+        root[<span class="hljs-string">"Quadtree"</span>] = factory()
+) @, <span class="hljs-function"><span class="hljs-params">()</span> -&gt;</span></pre></div>
+
+
+
+        <h2 id="the-quadtree-class">The Quadtree class</h2>
 
 
 
@@ -43,11 +61,11 @@ <h3 id="constructor">Constructor</h3>
 
 
 
-        <p>A quadtree constructor has 5 parameters :</p>
+        <p>The quadtree constructor accepts a single parameter object containing the following properties :</p>
 <ul>
-<li>x &amp; y coordinates which are always (0, 0) for the root tree.</li>
-<li>its dimensions (width &amp; length), mandatory.</li>
-<li>the maximum number of elements before the leaf ‘splits’ into subtrees. (defaults to 1)</li>
+<li>width / length : dimensions of the quadtree. [ <em>mandatory</em> ]</li>
+<li>maxElements : the maximum number of elements before the leaf ‘splits’ into subtrees. [ <em>defaults to 1</em> ]</li>
+<li>x / y : these coordinates are used internally by the library to position subtrees. [ <em>internal use only</em> ]</li>
 </ul>
 
 
@@ -487,7 +505,7 @@ <h3 id="exposed-methods">Exposed methods</h3>
 
 
 
-        <p>Opposite of filter</p>
+        <p>Opposite of filter.</p>
 
 
           <div class='highlight'><pre>    reject: <span class="hljs-function"><span class="hljs-params">(predicate)</span> -&gt;</span>
@@ -555,13 +573,6 @@ <h3 id="exposed-methods">Exposed methods</h3>
         str</pre></div>
 
 
-
-        <p>Require export.</p>
-
-
-          <div class='highlight'><pre><span class="hljs-built_in">module</span>?.exports = Quadtree</pre></div>
-
-
       <div class="fleur">h</div>
     </div>
   </div>

gulpfile.coffee

@@ -11,7 +11,7 @@ del         = require 'del'
 
 paths =
     src:        ['src/**/*.coffee']
-    demo:       ['demo/**/*', 'build/js/quadtree.min.js', 'build/js/quadtree.min.js.map']
+    demo:       ['demo/**/*', 'build/js/quadtree.min.js', 'build/js/quadtree.min.js.map', 'assets/*']
     test:       ['test/*.coffee']
     perf:       ['test/perf/*.coffee']
     docindex:   ['docs/quadtree.html']

src/quadtree.coffee

@@ -4,16 +4,25 @@
 # **Quadtree-lib** is an easy to use, developer friendly quadtree library
 # which contains many helper methods to add, remove, iterate, filter, simulate
 # collisions over 2d elements and more.
-#
-# The Quadtree class.
+
+# #### UMD bundling related code
+((root, factory) ->
+    if typeof define is 'function' and define.amd
+        define [], factory
+    else if typeof exports is 'object' and module.exports
+        module.exports = factory()
+    else
+        root["Quadtree"] = factory()
+) @, () ->
+# The Quadtree class
 # -------------------
 class Quadtree
     # ### Constructor
 
-    # A quadtree constructor has 5 parameters :
-    # - x & y coordinates which are always (0, 0) for the root tree.
-    # - its dimensions (width & length), mandatory.
-    # - the maximum number of elements before the leaf 'splits' into subtrees. (defaults to 1)
+    # The quadtree constructor accepts a single parameter object containing the following properties :
+    # - width / length : dimensions of the quadtree. [ *mandatory* ]
+    # - maxElements : the maximum number of elements before the leaf 'splits' into subtrees. [ *defaults to 1* ]
+    # - x / y : these coordinates are used internally by the library to position subtrees. [ *internal use only* ]
     constructor: ({@x, @y, @width, @height, @maxElements}) ->
 
         # An error is thrown when the width & length are not passed as constructor arguments.
@@ -394,7 +403,3 @@ class Quadtree
             if isParent then str += "#{indentation}└──┐\n"
 
         str
-
-
-# Require export.
-module?.exports = Quadtree