uzip - npm Package Compare versions

Comparing version 0.20191011.0 to 0.20191012.0

package.json

 {
 	"name": "uzip",
-	"version": "0.20191011.0",
+	"version": "0.20191012.0",
 	"files": [ "LICENSE", "README.md", "UZIP.js", "package.json" ],
@@ -5,0 +5,0 @@ "main": "./UZIP",

README.md

@@ -10,2 +10,18 @@ # UZIP.js
 
+## Installation
+
+**Web**: Add the `UZIP.js` script to your webpage:
+
+```html
+<script src="UZIP.js"></script>
+```
+
+**NodeJS**: Install the [`uzip` package](https://www.npmjs.com/package/uzip):
+
+```
+npm install uzip
+```
+
+## Interface
+
 #### `UZIP.parse(buff)`
@@ -21,4 +37,6 @@ * `buff`: ArrayBuffer of the ZIP file
 
+```js
     var obj = { "file.txt":new Uint8Array([72,69,76,76,79]),  "dir/photo.jpg":...,  "dir/pic.png":... };       
     var zip = UZIP.encode(obj);
+```
 
@@ -25,0 +43,0 @@ ## Deflate compression

No alert changes

Improved metrics

Total package byte prevSize

33966

0.72%

Number of lines in readme file

71

33.96%

No dependency changes