# Unzip Module

[![npm version](https://img.shields.io/npm/v/@xmcl/unzip.svg)](https://www.npmjs.com/package/@xmcl/unzip)
[![Downloads](https://img.shields.io/npm/dm/@xmcl/unzip.svg)](https://npmjs.com/@xmcl/unzip)
[![Install size](https://packagephobia.now.sh/badge?p=@xmcl/unzip)](https://packagephobia.now.sh/result?p=@xmcl/unzip)
[![npm](https://img.shields.io/npm/l/@xmcl/minecraft-launcher-core.svg)](https://github.com/voxelum/minecraft-launcher-core-node/blob/master/LICENSE)
[![Build Status](https://github.com/voxelum/minecraft-launcher-core-node/workflows/Build/badge.svg)](https://github.com/Voxelum/minecraft-launcher-core-node/actions?query=workflow%3ABuild)

A simple Unzipper wrapper for yauzl in nodejs.

Support `Promise` and nodejs `Stream`.

## Who might care this package

The people

1. who use nodejs 
2. who want a unzip only interface
3. who think yauzl is good but its API is hard to use

might want to look at this.

## Where is the document

Since this is majorly used in its [parent project](https://github.com/voxelum/minecraft-launcher-core-node). You can