improve README

Author: dehau

README.md

@@ -64,7 +64,7 @@ You can start using our SDK assuming you already have a [user token](https://dev
 
 Once you're done, you can send API request easily:
 
-- list projects: 
+- list projects:
     ```
     predicsisAPI.Projects
       .all()
@@ -90,18 +90,24 @@ See the [SDK documentation](http://yllieth.github.io/predicsis_ml_sdk-javascript
 //Get an HTML5 File instance
 fileInput.addEventListener('change', function(evt) {
   var file = evt.target.files[0];
-  s3FileHelper
-    .upload(file, function progressHandler(event) {
-      //Update a progress bar using standard XMLHttpRequestProgressEvent
-    })
-    .then(function(params) {
-      //file successfully uploaded to s3
-      var filename = params.filename;
-      var key = params.key;//S3 key
-    })
-    .catch(function(err){
-
-    });
+  predicsisAPI.uploadHelper
+    .processFile(file, { chunkSize: 50 * 1024 * 1024 });
+  $rootScope.$on('jsSDK.upload.starting', function(event, upload) {
+    console.log(upload.id, upload.fileName, upload.fileSize, upload.progression);
+  });
+  $rootScope.$on('jsSDK.upload.progress', function(event, upload) {
+    console.log(upload.id, upload.fileName, upload.fileSize, upload.progression, upload.path);
+  });
+  $rootScope.$on('jsSDK.upload.uploaded', function(event, upload) {
+    console.log(upload.id, upload.fileName, upload.fileSize, upload.progression, upload.path);
+  });
+  $rootScope.$on('jsSDK.upload.cancelled', function(event, upload) {
+    console.log(upload.id, upload.fileName, upload.fileSize, upload.progression, upload.path);
+  });
+  $rootScope.$on('jsSDK.upload.error', function(event, failure, retry) {
+    console.log(failure.id, failure.fileName, failure.path, failure.err);
+    retryButton.addEventListener('click', retry);
+  });
 });
 ```
 

lib/helper/uploadHelper.js

@@ -219,14 +219,13 @@ angular
      *     <td><kbd>created_at</kbd></td>
      *     <td>A timestamp in ISO format like <kbd>2014-05-02T15:27:37.687Z</kbd></td>
      *   </tr>
-     *   <tr>
-     *     <td><kbd>cancelUpload</kbd></td>
-     *     <td>A function which will stop the upload by aborting the request</td>
-     *   </tr>
      * </table>
      *
+     * error event does not provide created_at and progression but provides an err attribute
+     * this event is fired with a cancel callback as a second argument
+     *
      * About the <kbd>jsSDK.upload.starting</kbd> event. As it's fired before sending the
-     * "Get credential" request. So,
+     * upload creation request. So,
      * - you may have a delay between <kbd>jsSDK.upload.starting</kbd> and the first <kbd>jsSDK.upload.progress</kbd> events.
      * - the <kbd>path</kbd> parameter of the <kbd>uploadObject</kbd> object is not set
      *
@@ -262,7 +261,7 @@ angular
       });
       uploadRes.catch(function(err) {
         //delete concurrentUploads[uploadId];
-        $rootScope.$broadcast('jsSDK.upload.error', { fileName: file.name, id: uploadId, err: err }, function() {
+        $rootScope.$broadcast('jsSDK.upload.error', { fileName: file.name, id: uploadId, err: err, path: err.uploadPath }, function() {
           self.processFile(file, { chunkSize: chunkSize, uploadId: uploadId, serverUploadId: err.uploadId, uploadPath: err.uploadPath, fileOffset: err.fileOffset });
         });
       });