Initial commit

README.md

@@ -0,0 +1,75 @@
+FileSaver.js
+============
+
+FileSaver.js implements the W3C `saveAs()` [FileSaver][1] interface in browsers that do
+not natively support it. There is a [FileSaver.js demo][2] that demonstrates saving
+various media types.
+
+FileSaver.js is the solution to saving files on the client side, and is perfect for
+webapps that need to generate files or for saving sensitive information that shouldn't be
+sent to an external server.
+
+Supported Browsers
+------------------
+
+* Firefox 4+
+* †Google Chrome
+* Opera 11+
+* Safari 5+
+
+Unlisted versions of browsers (e.g. Firefox 3.6) will probably work too; I just haven't
+tested them.
+
+† Google Chrome 14+ supports saving with filenames
+
+Syntax
+------
+
+    FileSaver saveAs(in Blob data, in DOMString filename);
+
+Examples
+--------
+
+### Saving text
+
+    var bb = new BlobBuilder;
+    bb.append("Hello, world!");
+    saveAs(bb.getBlob("text/plain;charset=utf-8"), "hello world.txt");
+
+The standard W3C File API [`BlobBuilder`][3] interface is not available in all browsers.
+[BlobBuilder.js][4] is a cross-browser `BlobBuilder` implementation that solves this.
+
+### Saving a canvas
+
+    var canvas = document.getElementById("my-canvas"), ctx = canvas.getContext("2d");
+	// draw to canvas...
+    canvas.toBlob(function(blob) {
+        saveAs(blob, "pretty image.png");
+    });
+
+Note: The standard HTML5 `canvas.toBlob()` method is not available in all browsers.
+[canvas-toBlob.js][5] is a cross-browser `canvas.toBlob()` implementation that solves
+this.
+
+### Doing something after a file is saved
+
+    var filesaver = saveAs(blob, "secret stuff that you won't send to a server.truecrypt");
+    filesaver.onwriteend = function() {
+		// file saved, do something here
+    };
+
+### Aborting a save
+
+    var filesaver = saveAs(blob, "whatever");
+	cancel_button.addEventListener("click", function() {
+        filesaver.abort();
+    }, false);
+
+This isn't that useful unless you're saving very large files (e.g. generated video).
+
+
+  [1]: http://www.w3.org/TR/file-writer-api/#the-filesaver-interface
+  [2]: http://oftn.org/projects/FileSaver.js/demo/
+  [3]: http://www.w3.org/TR/file-writer-api/#the-blobbuilder-interface
+  [4]: https://github.com/eligrey/BlobBuilder.js
+  [5]: https://github.com/eligrey/canvas-toBlob.js