chore: switch to MIT license

CONTRIBUTING.md

@@ -33,7 +33,7 @@ Like artisans, we too need a toolset and process to create beautiful software. T
 
 
 ### Linting
-Well defined linting rules helps us in making code more consistent and avoid bugs. [ESLint](https://eslint.org) and [JSHint](http://jshint.com/) enforces these rules via their configuration files. These files are in the root of each repository.
+Well defined linting rules helps us in making code more consistent and avoid bugs. [ESLint](https://eslint.org) enforces these rules via its configuration file. This file is located in the root of each repository.
 
 
 ### Documenting

README.md

@@ -6,7 +6,7 @@ Language agnostic named entity recognizer
 
 [<img align="right" src="https://decisively.github.io/wink-logos/logo-title.png" width="100px" >](http://winkjs.org/)
 
-Recognize named entities in a sentence using **`wink-ner`**. It is a part of [wink](http://winkjs.org/) — a growing family of high quality packages for Statistical Analysis, Natural Language Processing and Machine Learning in NodeJS.
+Recognize named entities in a sentence using **`wink-ner`**. It is a smart Gazetteer-based Named Entity Recognizer (NER), which can be easily trained to suite specific needs. The wink-ner is capable of differentiating between `Manchester United` & `Manchester` in a single sentence and tagging them as a club and city respectively.
 
 ### Installation
 
@@ -15,7 +15,7 @@ Use [npm](https://www.npmjs.com/package/wink-ner) to install:
     npm install wink-ner --save
 
 ### Getting Started
-#### Simple Named Entity Recognition
+#### Named Entity Recognition
 ```javascript
 // Load wink ner.
 var ner = require( 'wink-ner' );
@@ -56,13 +56,9 @@ console.log( tokens );
 //    ]
 ```
 #### Integration with POS Tagging
-The `tokens` returned from `recognize()` may be further passed down to
-`tag()` api of [**`wink-pos-tagger`**](https://www.npmjs.com/package/wink-pos-tagger) for pos tagging.
+The `tokens` returned from `recognize()` may be further passed down to `tag()` api of [**`wink-pos-tagger`**](https://www.npmjs.com/package/wink-pos-tagger) for pos tagging.
 
-Just in case you need to assign
-a specific pos tag to an entity, the same can be achieved by including a property
-`pos` in the entity definition and assigning it the desired pos tag (e.g. `'NNP'`); the wink-pos-tagger
-will automatically do the needful. For details please refer to [`learn()`](#learn) api of wink-ner.
+Just in case you need to assign a specific pos tag to an entity, the same can be achieved by including a property `pos` in the entity definition and assigning it the desired pos tag (e.g. `'NNP'`); the wink-pos-tagger will automatically do the needful. For details please refer to [`learn()`](#learn) api of wink-ner.
 
 ```javascript
 // Load pos tagger.
@@ -95,9 +91,11 @@ Check out the [named entity recognizer API documentation](http://winkjs.org/wink
 
 If you spot a bug and the same has not yet been reported, raise a new [issue](https://github.com/winkjs/wink-ner/issues) or consider fixing it and sending a pull request.
 
+### About wink
+[Wink](http://winkjs.org/) is a family of open source packages for **Statistical Analysis**, **Natural Language Processing** and **Machine Learning** in NodeJS. The code is **thoroughly documented** for easy human comprehension and has a **test coverage of ~100%** for reliability to build production grade solutions.
+
 ### Copyright & License
 
 **wink-ner** is copyright 2017-18 [GRAYPE Systems Private Limited](http://graype.in/).
 
-It is licensed under the under the terms of the GNU Affero General Public License as published by the Free
-Software Foundation, version 3 of the License.
+It is licensed under the terms of the MIT License.

docs/NER.html

@@ -87,7 +87,7 @@ <h4 class="name" id="defineConfig"><span class="type-signature"></span>defineCon
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="wink-ner.js.html">wink-ner.js</a>, <a href="wink-ner.js.html#line63">line 63</a>
+        <a href="wink-ner.js.html">wink-ner.js</a>, <a href="wink-ner.js.html#line66">line 66</a>
     </li></ul></dd>
 
 
@@ -479,7 +479,7 @@ <h4 class="name" id="exportJSON"><span class="type-signature"></span>exportJSON<
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="wink-ner.js.html">wink-ner.js</a>, <a href="wink-ner.js.html#line621">line 621</a>
+        <a href="wink-ner.js.html">wink-ner.js</a>, <a href="wink-ner.js.html#line624">line 624</a>
     </li></ul></dd>
 
 
@@ -591,7 +591,7 @@ <h4 class="name" id="importJSON"><span class="type-signature"></span>importJSON<
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="wink-ner.js.html">wink-ner.js</a>, <a href="wink-ner.js.html#line645">line 645</a>
+        <a href="wink-ner.js.html">wink-ner.js</a>, <a href="wink-ner.js.html#line648">line 648</a>
     </li></ul></dd>
 
 
@@ -783,7 +783,7 @@ <h4 class="name" id="learn"><span class="type-signature"></span>learn<span class
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="wink-ner.js.html">wink-ner.js</a>, <a href="wink-ner.js.html#line280">line 280</a>
+        <a href="wink-ner.js.html">wink-ner.js</a>, <a href="wink-ner.js.html#line283">line 283</a>
     </li></ul></dd>
 
 
@@ -1138,7 +1138,7 @@ <h4 class="name" id="recognize"><span class="type-signature"></span>recognize<sp
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="wink-ner.js.html">wink-ner.js</a>, <a href="wink-ner.js.html#line477">line 477</a>
+        <a href="wink-ner.js.html">wink-ner.js</a>, <a href="wink-ner.js.html#line480">line 480</a>
     </li></ul></dd>
 
 
@@ -1325,7 +1325,7 @@ <h4 class="name" id="reset"><span class="type-signature"></span>reset<span class
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="wink-ner.js.html">wink-ner.js</a>, <a href="wink-ner.js.html#line604">line 604</a>
+        <a href="wink-ner.js.html">wink-ner.js</a>, <a href="wink-ner.js.html#line607">line 607</a>
     </li></ul></dd>
 
 
@@ -1441,7 +1441,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Oct 26 2018 13:26:00 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Nov 04 2018 10:45:37 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/global.html

@@ -133,7 +133,7 @@ <h4 class="name" id="ner"><span class="type-signature"></span>ner<span class="si
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="wink-ner.js.html">wink-ner.js</a>, <a href="wink-ner.js.html#line40">line 40</a>
+        <a href="wink-ner.js.html">wink-ner.js</a>, <a href="wink-ner.js.html#line43">line 43</a>
     </li></ul></dd>
 
 
@@ -251,7 +251,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Oct 26 2018 13:26:00 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Nov 04 2018 10:45:37 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/index.html

@@ -52,9 +52,9 @@ <h2><a href="index.html">Home</a></h2><h2><a href="http://winkjs.org" target="_b
     <section class="readme">
         <article><h1>wink-ner</h1><p>Language agnostic named entity recognizer</p>
 <h3><a href="https://travis-ci.org/winkjs/wink-ner"><img src="https://api.travis-ci.org/winkjs/wink-ner.svg?branch=master" alt="Build Status"></a> <a href="https://coveralls.io/github/winkjs/wink-ner?branch=master"><img src="https://coveralls.io/repos/github/winkjs/wink-ner/badge.svg?branch=master" alt="Coverage Status"></a> <a href="http://inch-ci.org/github/winkjs/wink-ner"><img src="http://inch-ci.org/github/winkjs/wink-ner.svg?branch=master" alt="Inline docs"></a> <a href="https://david-dm.org/winkjs/wink-ner"><img src="https://david-dm.org/winkjs/wink-ner/status.svg" alt="dependencies Status"></a> <a href="https://david-dm.org/winkjs/wink-ner?type=dev"><img src="https://david-dm.org/winkjs/wink-ner/dev-status.svg" alt="devDependencies Status"></a> <a href="https://gitter.im/winkjs/Lobby"><img src="https://img.shields.io/gitter/room/nwjs/nw.js.svg" alt="Gitter"></a></h3><p><a href="http://winkjs.org/"><img align="right" src="https://decisively.github.io/wink-logos/logo-title.png" width="100px" ></a></p>
-<p>Recognize named entities in a sentence using <strong><code>wink-ner</code></strong>. It is a part of <a href="http://winkjs.org/">wink</a> — a growing family of high quality packages for Statistical Analysis, Natural Language Processing and Machine Learning in NodeJS.</p>
+<p>Recognize named entities in a sentence using <strong><code>wink-ner</code></strong>. It is a smart Gazetteer-based Named Entity Recognizer (NER), which can be easily trained to suite specific needs. The wink-ner is capable of differentiating between <code>Manchester United</code> &amp; <code>Manchester</code> in a single sentence and tagging them as a club and city respectively.</p>
 <h3>Installation</h3><p>Use <a href="https://www.npmjs.com/package/wink-ner">npm</a> to install:</p>
-<pre class="prettyprint source"><code>npm install wink-ner --save</code></pre><h3>Getting Started</h3><h4>Simple Named Entity Recognition</h4><pre class="prettyprint source lang-javascript"><code>// Load wink ner.
+<pre class="prettyprint source"><code>npm install wink-ner --save</code></pre><h3>Getting Started</h3><h4>Named Entity Recognition</h4><pre class="prettyprint source lang-javascript"><code>// Load wink ner.
 var ner = require( 'wink-ner' );
 // Create your instance of wink ner & use defualt config.
 var myNER = ner();
@@ -90,12 +90,8 @@ <h3>Installation</h3><p>Use <a href="https://www.npmjs.com/package/wink-ner">npm
 //      { entityType: 'country', uid: 'uk', originalSeq: [ 'U', '.', 'K' ],
 //        value: 'u k', tag: 'word' },
 //      { value: '.', tag: 'punctuation' }
-//    ]</code></pre><h4>Integration with POS Tagging</h4><p>The <code>tokens</code> returned from <code>recognize()</code> may be further passed down to
-<code>tag()</code> api of <a href="https://www.npmjs.com/package/wink-pos-tagger"><strong><code>wink-pos-tagger</code></strong></a> for pos tagging.</p>
-<p>Just in case you need to assign
-a specific pos tag to an entity, the same can be achieved by including a property
-<code>pos</code> in the entity definition and assigning it the desired pos tag (e.g. <code>'NNP'</code>); the wink-pos-tagger
-will automatically do the needful. For details please refer to <a href="#learn"><code>learn()</code></a> api of wink-ner.</p>
+//    ]</code></pre><h4>Integration with POS Tagging</h4><p>The <code>tokens</code> returned from <code>recognize()</code> may be further passed down to <code>tag()</code> api of <a href="https://www.npmjs.com/package/wink-pos-tagger"><strong><code>wink-pos-tagger</code></strong></a> for pos tagging.</p>
+<p>Just in case you need to assign a specific pos tag to an entity, the same can be achieved by including a property <code>pos</code> in the entity definition and assigning it the desired pos tag (e.g. <code>'NNP'</code>); the wink-pos-tagger will automatically do the needful. For details please refer to <a href="#learn"><code>learn()</code></a> api of wink-ner.</p>
 <pre class="prettyprint source lang-javascript"><code>// Load pos tagger.
 var tagger = require( 'wink-pos-tagger' );
 // Instantiate it and extract tag api.
@@ -118,9 +114,9 @@ <h3>Installation</h3><p>Use <a href="https://www.npmjs.com/package/wink-ner">npm
 //      { value: '.', tag: 'punctuation', normal: '.', pos: '.' }
 //    ]</code></pre><h3>Documentation</h3><p>Check out the <a href="http://winkjs.org/wink-ner/">named entity recognizer API documentation</a> to learn more.</p>
 <h3>Need Help?</h3><p>If you spot a bug and the same has not yet been reported, raise a new <a href="https://github.com/winkjs/wink-ner/issues">issue</a> or consider fixing it and sending a pull request.</p>
+<h3>About wink</h3><p><a href="http://winkjs.org/">Wink</a> is a family of open source packages for <strong>Statistical Analysis</strong>, <strong>Natural Language Processing</strong> and <strong>Machine Learning</strong> in NodeJS. The code is <strong>thoroughly documented</strong> for easy human comprehension and has a <strong>test coverage of ~100%</strong> for reliability to build production grade solutions.</p>
 <h3>Copyright &amp; License</h3><p><strong>wink-ner</strong> is copyright 2017-18 <a href="http://graype.in/">GRAYPE Systems Private Limited</a>.</p>
-<p>It is licensed under the under the terms of the GNU Affero General Public License as published by the Free
-Software Foundation, version 3 of the License.</p></article>
+<p>It is licensed under the terms of the MIT License.</p></article>
     </section>
 
 
@@ -135,7 +131,7 @@ <h3>Copyright &amp; License</h3><p><strong>wink-ner</strong> is copyright 2017-1
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Oct 26 2018 13:26:00 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Nov 04 2018 10:45:37 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>

docs/wink-ner.js.html

@@ -48,20 +48,23 @@ <h1 class="page-title">wink-ner.js</h1>
 //
 //     This file is part of “wink-ner”.
 //
-//     “wink-ner” is free software: you can redistribute it
-//     and/or modify it under the terms of the GNU Affero
-//     General Public License as published by the Free
-//     Software Foundation, version 3 of the License.
+//     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:
 //
-//     “wink-ner” is distributed in the hope that it will
-//     be useful, but WITHOUT ANY WARRANTY; without even
-//     the implied warranty of MERCHANTABILITY or FITNESS
-//     FOR A PARTICULAR PURPOSE.  See the GNU Affero General
-//     Public License for more details.
+//     The above copyright notice and this permission notice shall be included
+//     in all copies or substantial portions of the Software.
 //
-//     You should have received a copy of the GNU Affero
-//     General Public License along with “wink-ner”.
-//     If not, see &lt;http://www.gnu.org/licenses/>.
+//     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.
 
 //
 var singularize = require( 'wink-lemmatizer' ).lemmatizeNoun;
@@ -768,7 +771,7 @@ <h1 class="page-title">wink-ner.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Oct 26 2018 13:26:00 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Nov 04 2018 10:45:37 GMT+0530 (IST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>