gunzip
Version:
Compress or expand files using LZ77 and Huffman coding
38 lines (25 loc) • 1.33 kB
Markdown
# gunzip
> 🗜 Compress or expand files using [LZ77](https://en.wikipedia.org/wiki/LZ77_and_LZ78) and [Huffman coding](https://en.wikipedia.org/wiki/Huffman_coding).
I'm aspiring to make open-source my full-time work. If you like the work that I do, please consider supporting me.
[![Coffee][badge_coffee_donate]](https://www.buymeacoffee.com/adamzerella)
[![PayPal][badge_paypal_donate]](https://www.paypal.me/adamzerella)
## Install
```bash
npm i -g gunzip
```
## Usage
This module is currently only provides extremely basic functionality to compress or decompress a given file. If the community seems interested in developing this further, more features and refinements will be added.
### CLI
```bash
# Compress a file using gzip
gunzip file.txt
# Decompress a file, assuming gzip
gunzip -d file.txt.gz
```
## Contribute
Don't be scared raise an issue or a pull request! Any contributions, no matter how big or small will land your picture here.
<div style="display:inline;">
<a href="https://github.com/adamzerella"><img width="64" height="64" src="https://avatars0.githubusercontent.com/u/1501560?s=460&v=4" alt="Adam Zerella"/></a>
</div>
[badge_coffee_donate]: https://adamzerella.com/badges/coffee.svg
[badge_paypal_donate]: https://adamzerella.com/badges/paypal.svg