docs: rename to flow.js and added origin section

Author: AidasK

README.md

@@ -1,49 +1,46 @@
-# Lets rename this library! [Click to vote](https://docs.google.com/forms/d/1k_xUuXWbWbFZlCJDb43vAltcrJzighrdpk8-z8KU2ys/viewform)
+## Flow.js [![Build Status](https://travis-ci.org/resumable2/resumable.js.png)](https://travis-ci.org/resumable2/resumable.js) [![Coverage Status](https://coveralls.io/repos/resumable2/resumable.js/badge.png?branch=master)](https://coveralls.io/r/resumable2/resumable.js?branch=master)
 
 
-## Resumable.js v2 [![Build Status](https://travis-ci.org/resumable2/resumable.js.png)](https://travis-ci.org/resumable2/resumable.js) [![Coverage Status](https://coveralls.io/repos/resumable2/resumable.js/badge.png?branch=master)](https://coveralls.io/r/resumable2/resumable.js?branch=master)
-
-
-Resumable.js is a JavaScript library providing multiple simultaneous, stable and resumable uploads via the HTML5 File API. 
+Flow.js is a JavaScript library providing multiple simultaneous, stable and resumable uploads via the HTML5 File API. 
 
 The library is designed to introduce fault-tolerance into the upload of large files through HTTP. This is done by splitting each file into small chunks. Then, whenever the upload of a chunk fails, uploading is retried until the procedure completes. This allows uploads to automatically resume uploading after a network connection is lost either locally or to the server. Additionally, it allows for users to pause, resume and even recover uploads without losing state because only the currently uploading chunks will be aborted, not the entire upload.
 
-Resumable.js does not have any external dependencies other than the `HTML5 File API`. This is relied on for the ability to chunk files into smaller pieces. Currently, this means that support is limited to Firefox 4+, Chrome 11+, Safari 6+ and Internet Explorer 10+.
+Flow.js does not have any external dependencies other than the `HTML5 File API`. This is relied on for the ability to chunk files into smaller pieces. Currently, this means that support is limited to Firefox 4+, Chrome 11+, Safari 6+ and Internet Explorer 10+.
 
 Samples and examples are available in the `samples/` folder. Please push your own as Markdown to help document the project.
 
 ## Can i see a demo?
-[Resumable.js + angular.js file upload demo](http://resumable2.github.io/ng-resumable/) - ng-resumable extension page https://github.com/resumable2/ng-resumable
+[Flow.js + angular.js file upload demo](http://flowjs.github.io/ng-flow/) - ng-flow extension page https://github.com/flowjs/ng-flow
 
-JQuery and node.js backend demo https://github.com/resumable2/resumable.js/tree/master/samples/Node.js
+JQuery and node.js backend demo https://github.com/flowjs/flow.js/tree/master/samples/Node.js
 
 ## How can I install it?
 use bower:
 
-        bower install resumable.js#~2
-use cdn, look for available packages at http://www.jsdelivr.com/#!resumable.js
+        bower install flow.js#~2
+use cdn, look for available packages at http://www.jsdelivr.com/#!flow.js
 
 or use git clone
 
-        git clone https://github.com/resumable2/resumable.js
+        git clone https://github.com/flowjs/flow.js
 
 ## How can I use it?
 
-A new `Resumable` object is created with information of what and where to post:
+A new `Flow` object is created with information of what and where to post:
 
-    var r = new Resumable({
+    var flow = new Flow({
       target:'/api/photo/redeem-upload-token', 
       query:{upload_token:'my_token'}
     });
-    // Resumable.js isn't supported, fall back on a different method
-    if(!r.support) location.href = '/some-old-crappy-uploader';
+    // Flow.js isn't supported, fall back on a different method
+    if(!flow.support) location.href = '/some-old-crappy-uploader';
 
 To allow files to be either selected and drag-dropped, you'll assign drop target and a DOM item to be clicked for browsing:
 
-    r.assignBrowse(document.getElementById('browseButton'));
-    r.assignDrop(document.getElementById('dropTarget'));
+    flow.assignBrowse(document.getElementById('browseButton'));
+    flow.assignDrop(document.getElementById('dropTarget'));
 
-After this, interaction with Resumable.js is done by listening to events:
+After this, interaction with Flow.js is done by listening to events:
 
     r.on('fileAdded', function(file, event){
         ...
@@ -57,19 +54,19 @@ After this, interaction with Resumable.js is done by listening to events:
 
 ## How do I set it up with my server?
 
-Most of the magic for Resumable.js happens in the user's browser, but files still need to be reassembled from chunks on the server side. This should be a fairly simple task and can be achieved in any web framework or language, which is able to receive file uploads.
+Most of the magic for Flow.js happens in the user's browser, but files still need to be reassembled from chunks on the server side. This should be a fairly simple task and can be achieved in any web framework or language, which is able to receive file uploads.
 
 To handle the state of upload chunks, a number of extra parameters are sent along with all requests:
 
-* `resumableChunkNumber`: The index of the chunk in the current upload. First chunk is `1` (no base-0 counting here).
-* `resumableTotalChunks`: The total number of chunks.  
-* `resumableChunkSize`: The general chunk size. Using this value and `resumableTotalSize` you can calculate the total number of chunks. Please note that the size of the data received in the HTTP might be lower than `resumableChunkSize` of this for the last chunk for a file.
-* `resumableTotalSize`: The total file size.
-* `resumableIdentifier`: A unique identifier for the file contained in the request.
-* `resumableFilename`: The original file name (since a bug in Firefox results in the file name not being transmitted in chunk multipart posts).
-* `resumableRelativePath`: The file's relative path when selecting a directory (defaults to file name in all browsers except Chrome).
+* `flowChunkNumber`: The index of the chunk in the current upload. First chunk is `1` (no base-0 counting here).
+* `flowTotalChunks`: The total number of chunks.  
+* `flowChunkSize`: The general chunk size. Using this value and `flowTotalSize` you can calculate the total number of chunks. Please note that the size of the data received in the HTTP might be lower than `flowChunkSize` of this for the last chunk for a file.
+* `flowTotalSize`: The total file size.
+* `flowIdentifier`: A unique identifier for the file contained in the request.
+* `flowFilename`: The original file name (since a bug in Firefox results in the file name not being transmitted in chunk multipart posts).
+* `flowRelativePath`: The file's relative path when selecting a directory (defaults to file name in all browsers except Chrome).
 
-You should allow for the same chunk to be uploaded more than once; this isn't standard behaviour, but on an unstable network environment it could happen, and this case is exactly what Resumable.js is designed for.
+You should allow for the same chunk to be uploaded more than once; this isn't standard behaviour, but on an unstable network environment it could happen, and this case is exactly what Flow.js is designed for.
 
 For every request, you can confirm reception in HTTP status codes (can be change through the `permanentErrors` option):
 
@@ -79,7 +76,7 @@ For every request, you can confirm reception in HTTP status codes (can be change
 
 ## Handling GET (or `test()` requests)
 
-Enabling the `testChunks` option will allow uploads to be resumed after browser restarts and even across browsers (in theory you could even run the same file upload across multiple tabs or different browsers).  The `POST` data requests listed are required to use Resumable.js to receive data, but you can extend support by implementing a corresponding `GET` request with the same parameters:
+Enabling the `testChunks` option will allow uploads to be resumed after browser restarts and even across browsers (in theory you could even run the same file upload across multiple tabs or different browsers).  The `POST` data requests listed are required to use Flow.js to receive data, but you can extend support by implementing a corresponding `GET` request with the same parameters:
 
 * If this request returns a `200` HTTP code, the chunks is assumed to have been completed.
 * If the request returns anything else, the chunk will be uploaded in the standard fashion.
@@ -88,12 +85,12 @@ After this is done and `testChunks` enabled, an upload can quickly catch up even
 
 ## Full documentation
 
-### Resumable
+### Flow
 #### Configuration
 
 The object is loaded with a configuration options:
 
-    var r = new Resumable({opt1:'val', ...});
+    var r = new Flow({opt1:'val', ...});
 
 Available configuration options are:
 
@@ -103,7 +100,7 @@ Available configuration options are:
 * `forceChunkSize` Force all chunks to be less or equal than chunkSize. Otherwise, the last chunk will be greater than or equal to `chunkSize`. (Default: `false`)
 * `simultaneousUploads` Number of simultaneous uploads (Default: `3`)
 * `fileParameterName` The name of the multipart POST parameter to use for the file chunk  (Default: `file`)
-* `query` Extra parameters to include in the multipart POST with data. This can be an object or a function. If a function, it will be passed a ResumableFile and a ResumableChunk object (Default: `{}`)
+* `query` Extra parameters to include in the multipart POST with data. This can be an object or a function. If a function, it will be passed a FlowFile and a FlowChunk object (Default: `{}`)
 * `headers` Extra headers to include in the multipart POST with data (Default: `{}`)
 * `withCredentials` Standard CORS requests do not send or set any cookies by default. In order to
  include cookies as part of the request, you need to set the `withCredentials` property to true.
@@ -125,25 +122,25 @@ parameter must be adjusted together with `progressCallbacksInterval` parameter.
 
 #### Properties
 
-* `.support` A boolean value indicator whether or not Resumable.js is supported by the current browser.
-* `.opts` A hash object of the configuration of the Resumable.js instance.
-* `.files` An array of `ResumableFile` file objects added by the user (see full docs for this object type below).
+* `.support` A boolean value indicator whether or not Flow.js is supported by the current browser.
+* `.opts` A hash object of the configuration of the Flow.js instance.
+* `.files` An array of `FlowFile` file objects added by the user (see full docs for this object type below).
 
 #### Methods
 
 * `.assignBrowse(domNodes, isDirectory, singleFile)` Assign a browse action to one or more DOM nodes.  Pass in `true` to allow directories to be selected (Chrome only). To prevent multiple file uploads
 set singleFile to true.
 * `.assignDrop(domNodes)` Assign one or more DOM nodes as a drop target.
-* `.on(event, callback)` Listen for event from Resumable.js (see below)
+* `.on(event, callback)` Listen for event from Flow.js (see below)
 * `.upload()` Start or resume uploading.
 * `.pause()` Pause uploading.
 * `.resume()` Resume uploading.
-* `.cancel()` Cancel upload of all `ResumableFile` objects and remove them from the list.
+* `.cancel()` Cancel upload of all `FlowFile` objects and remove them from the list.
 * `.progress()` Returns a float between 0 and 1 indicating the current upload progress of all files.
 * `.isUploading()` Returns a boolean indicating whether or not the instance is currently uploading anything.
 * `.addFile(file)` Add a HTML5 File object to the list of files.
-* `.removeFile(file)` Cancel upload of a specific `ResumableFile` object on the list from the list.
-* `.getFromUniqueIdentifier(uniqueIdentifier)` Look up a `ResumableFile` object by its unique identifier.
+* `.removeFile(file)` Cancel upload of a specific `FlowFile` object on the list from the list.
+* `.getFromUniqueIdentifier(uniqueIdentifier)` Look up a `FlowFile` object by its unique identifier.
 * `.getSize()` Returns the total size of the upload in bytes.
 
 #### Events
@@ -152,43 +149,43 @@ set singleFile to true.
 * `.fileProgress(file)` Uploading progressed for a specific file.
 * `.fileAdded(file, event)` This event is used for file validation. To reject this file return false.
 This event is also called before file is added to upload queue,
-this means that calling `Resumable.upload()` function will not start current file upload.
+this means that calling `flow.upload()` function will not start current file upload.
 Optionally, you can use the browser `event` object from when the file was
 added.
 * `.filesAdded(array, event)` Same as fileAdded, but used for multiple file validation.
 * `.filesSubmitted(array, event)` Can be used to start upload of currently added files.
 * `.fileRetry(file)` Something went wrong during upload of a specific file, uploading is being retried.
 * `.fileError(file, message)` An error occured during upload of a specific file.
-* `.uploadStart()` Upload has been started on the Resumable object.
+* `.uploadStart()` Upload has been started on the Flow object.
 * `.complete()` Uploading completed.
 * `.progress()` Uploading progress.
 * `.error(message, file)` An error, including fileError, occured.
 * `.catchAll(event, ...)` Listen to all the events listed above with the same callback function.
 
-### ResumableFile
-ResumableFile constructor can be accessed in `Resumable.ResumableFile`.
+### FlowFile
+FlowFile constructor can be accessed in `Flow.FlowFile`.
 #### Properties
 
-* `.resumableObj` A back-reference to the parent `Resumable` object.
+* `.flowObj` A back-reference to the parent `Flow` object.
 * `.file` The correlating HTML5 `File` object.
 * `.fileName` The name of the file.
 * `.relativePath` The relative path to the file (defaults to file name if relative path doesn't exist)
 * `.size` Size in bytes of the file.
 * `.uniqueIdentifier` A unique identifier assigned to this file object. This value is included in uploads to the server for reference, but can also be used in CSS classes etc when building your upload UI.
 * `.averageSpeed` Average upload speed, bytes per second.
 * `.currentSpeed` Current upload speed, bytes per second.
-* `.chunks` An array of `ResumableChunk` items. You shouldn't need to dig into these.
+* `.chunks` An array of `FlowChunk` items. You shouldn't need to dig into these.
 * `.paused` Indicated if file is paused.
 * `.error` Indicated if file has encountered an error.
 
 #### Methods
 
-* `.progress(relative)` Returns a float between 0 and 1 indicating the current upload progress of the file. If `relative` is `true`, the value is returned relative to all files in the Resumable.js instance.
+* `.progress(relative)` Returns a float between 0 and 1 indicating the current upload progress of the file. If `relative` is `true`, the value is returned relative to all files in the Flow.js instance.
 * `.pause()` Pause uploading the file.
 * `.resume()` Resume uploading the file.
 * `.cancel()` Abort uploading the file and delete it from the list of files to upload.
 * `.retry()` Retry uploading the file.
-* `.bootstrap()` Rebuild the state of a `ResumableFile` object, including reassigning chunks and XMLHttpRequest instances.
+* `.bootstrap()` Rebuild the state of a `FlowFile` object, including reassigning chunks and XMLHttpRequest instances.
 * `.isUploading()` Returns a boolean indicating whether file chunks is uploading.
 * `.isComplete()` Returns a boolean indicating whether the file has completed uploading and received a server response.
 * `.sizeUploaded()` Returns size uploaded in bytes.
@@ -209,11 +206,11 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
 ## Installation Dependencies
 1. To clone your Github repository, run:
 
-        git clone [email protected]:<github username>/resumable.js.git
+        git clone [email protected]:<github username>/flow.js.git
 
-2. To go to the Resumable.js directory, run:
+2. To go to the Flow.js directory, run:
 
-        cd resumable.js
+        cd flow.js
 
 3. To add node.js dependencies
 
@@ -242,3 +239,6 @@ Automated tests is running after every commit at travis-ci.
 2. `grunt  test --sauce-local=true --sauce-username=**** --sauce-access-key=***`
 
 other browsers can be used with `--browsers` flag, available browsers: sl_opera,sl_iphone,sl_safari,sl_ie10,sl_chorme,sl_firefox
+
+## Origin
+Flow.js was inspired by and evolved from https://github.com/23/resumable.js. Library has been supplemented with tests and features, such as drag and drop for folders, upload speed, time remaining estimation, separate files pause, resume and more.