jszip/README.markdown

Create, read and edit .zip files with Javascript http://stuartk.com/jszip

JSZip
=====

A library for creating, reading and editing .zip files with Javascript, with a
lovely and simple API.

See http://stuartk.com/jszip for all the documentation

```javascript
var zip = new JSZip();

zip.file("Hello.txt", "Hello World\n");

var img = zip.folder("images");
img.file("smile.gif", imgData, {base64: true});

var content = zip.generate();

location.href = "data:application/zip;base64," + content;
/*
Results in a zip containing
Hello.txt
images/
    smile.gif
*/
```

License
=======

JSZip is dual-licensed. You may use it under the MIT license *or* the GPLv3
license. See LICENSE.markdown.