Merge remote-tracking branch 'origin/5.x' into 3-data-validation

Author: samniisan

.travis.yml

@@ -24,7 +24,7 @@ deploy:
   skip_cleanup: true
   email: support@kuzzle.io
   api_key:
-    secure: fyAUrBhmctUri2wPCcdufPME6EyFLpC4OS4wMAmUc7iNNSUl2C9On0HMkmz1JKD/+fMhlFCvQcpD6O8hNThneSqrv/PANAyz9YXblv35W9v1XbYrzm5IWQ4D30+Zg350SK6Wqn4Wr6jZkRXQKhBo8GQ5aLsDdhr7RgRBpw8p6GwDuda41K9cAOh8vbX2u6guOfeJW+jfwfXgwZUl/DEor8XkIJYcVwOF0989FT0urYf28afnxVgaj5XuIyNQMLC0R0KAsbYO0EPDy1O7a34SFUoNVBXPqP+5wYocML6mKNOFtLfvTAfIeErQc6Is3roJvZqMkcu8zzRH+OdbQfa+3+sUTPbxBAaNvcITO/z36QnYh/Swbnfxn0dD5ue2bAXseVpa55fWw0DPOQkcQ3VJ9hHQfMWTn+4EH6lqYEynSJ0KGbHqzm3Qm15fCj0s+vjvs4axGcYEpZlJaTu9o3oHYJTTDfbkk4b7nbKGQ/vDsYFTRL2yRprYlCQ8YoUnDMOB3YHxmRs7Jgxb9lbg8iD5ZMtP1+QIhUMJTI16ruxs88bRvCaTkfdTOGv0qVhgA9a00+G1XMLxCzpvI8wKgo7+GKRPUyvR2bRCQS6mHtbp6beCqPxgzyfGzg8XU09disST7spqH3E8ohWwVfgkjoBlS9+y62iaiwXRsTVXyeGJpac=
+    secure: pGn0KMYzJGeZBR39VettlAwelab2sXFQqFi8GuTWUGXBcQDehTBUS5hI8kfJNnKGpqnUNmgZz5pRrpZseSmZA/NenrZIH9ojm6cljpdGzZNYKHRGr1kIWuBpPgQyt5Zvv3mAyW6eHrX6Y5fPRv4RFBbpQPC5L29lEdBU6r4fo0QofT0hNVEnNUrBOw4+qs/qTGlvA5mDN078+GBW1s4KmdCYT7duK7R3W/q1MZK3bkNUk068tyyaeMM3KPSOVfNbrI0mzYFD/z9Wkxv+Z6ZXlKvYSl/I6XRfS/tjgSVE1Uo5f8O5oE5s0zSkTGSNNuDBcmFpnxFVZulbg2aek1rdqGSKwoATSiQQFv5ZDR40UlP+XGNOamZaHSVZusResHAWme6TzRDZVJO1QnJ33KvqnhhVGqcT5eT5c+TDqST0cEg6eh531LcnKjreb+E+9AVSTIgU1WSfzX82BsceMYU8LA+FH3PJ51Itc4fsBgt+mMLxf/LRSF75HN7fD9bEk+FyrX65vqhcC8Ax4Nc7hwGP5EoIE1r+/1RWpYaS3Mk5/ooUcpnkzI3FFVmYKoANuI/NuJe5W+cvobwKcHDQrK43ON5CGaa/yDOu12eSDY1pikVdJxvMhKhwtbdiUcWF5L+hRITxKT60sjE4BMEWBaXTquAH4NR1g+UiX3fVEKRbIwU=
   on:
     repo: kuzzleio/sdk-javascript
     branch: master

README.md

@@ -4,29 +4,29 @@
 Official Kuzzle Javascript SDK
 ======
 
-This SDK version is compatible with Kuzzle 1.0.0-RC9.5 and higher
-
 ## About Kuzzle
 
-For UI and linked objects developers, Kuzzle is an open-source solution that handles all the data management (CRUD, real-time storage, search, high-level features, etc).
+A backend software, self-hostable and ready to use to power modern apps.
 
 You can access the Kuzzle repository on [Github](https://github.com/kuzzleio/kuzzle)
 
+* [Basic usage](#basic-usage)
 * [SDK Documentation](#sdk-documentation)
+* [Report an issue](#report-an-issue)
 * [Protocols used](#protocols-used)
 * [Installation](#installation)
   * [NodeJS](#nodejs)
-    * [Basic usage](#basic-usage-node)
   * [Javascript](#javascript)
-    * [Basic usage](#basic-usage-js)
 * [Building manually](#building-manually)
-* [Migrating from SDK v1.x](#migrating-from-sdk-v1.x)
-* [Note](#note)
 * [License](#license)
 
+## Basic usage
+
+Follow [Kuzzle Guide](http://docs.kuzzle.io/guide/getting-started/#sdk-play-time)
+
 ## SDK Documentation
 
-The complete SDK documentation is available [here](http://docs.kuzzle.io/sdk-reference/?javascript#kuzzle)
+The complete SDK documentation is available [here](http://docs.kuzzle.io/sdk-reference/)
 
 ## Report an issue
 
@@ -59,47 +59,6 @@ This SDK can be used either in NodeJS or in a browser.
 npm install kuzzle-sdk --save
 ```
 
-#### <a name="basic-usage-node"></a> Basic usage
-
-```javascript
-var
-  Kuzzle = require('kuzzle-sdk'),
-  kuzzle = new Kuzzle('serverName');
-
-var myDoc = {
-  name: 'Rick Astley',
-  birthDate: '1966/02/06',
-  mainActivity: 'Singer',
-  website: 'http://www.rickastley.co.uk',
-  comment: 'Never gonna give you up, never gonna let you down'
-};
-
-kuzzle
-  .dataCollectionFactory('music', 'people')
-  .createDocument(myDoc, function(error, response) {
-    if (error) {
-      // handle error...
-    }
-    /*
-    'response' is a KuzzleDocument object
-    */
-});
-
-// In NodeJS version, you can also use Promise by suffixing functions with "Promise"
-kuzzle
-  .dataCollectionFactory('music', 'people')
-  .createDocumentPromise(myDoc)
-  .then(response => {
-    /*
-    'response' is a KuzzleDocument object
-    */
-  })
-  .catch(error => {
-    // handle error here
-  });
-});
-```
-
 ### Javascript
 
 Clone this github repository and run ``npm run build``. A ``dist`` directory will be created, containing a browser version of this SDK.
@@ -116,40 +75,6 @@ If you want to support older browser versions, you may load `socket.io` before K
 <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/socket.io/1.6.0/socket.io.min.js"></script>
 ```
 
-#### <a name="basic-usage-js"></a> Basic usage
-
-```javascript
-var
-  kuzzle = new Kuzzle('serverName');
-
-var myDoc = {
-  name: 'Rick Astley',
-  birthDate: '1966/02/06',
-  mainActivity: 'Singer',
-  website: 'http://www.rickastley.co.uk',
-  comment: 'Never gonna give you up, never gonna let you down'
-};
-
-kuzzle
-  .dataCollectionFactory('music', 'people')
-  .createDocument(myDoc, function(error, response) {
-    if (error) {
-      // handle error...
-    }
-    /*
-    'response' is a KuzzleDocument object
-    */
-});
-```
-
-## Migrating from SDK v1.x
-
-* Kuzzle constructor has been changed. Instead of an URL, you have to provide a resolvable server name, or an IP address. If you need to specify a port different than the provided default value, you can do so using the `port` option.
-
-## Note
-
-* bufferutil and utf-8-validate have been moved to peerDependencies
-
 ## License
 
 [Apache 2](LICENSE.md)

dist/kuzzle.js

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-sdk",
-  "version": "4.0.1",
+  "version": "5.0.2",
   "description": "Official Javascript SDK for Kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
   "repository": {