dir-packer/README.md

A tool for packing directories into tar.gz files.

# dir-packer

A tool for packing directories into tar.gz files.

[![Dependency Status](https://david-dm.org/ungjs/dir-packer/status.svg?style=flat)](https://david-dm.org/ungjs/dir-packer)
[![Build Status](http://img.shields.io/travis/ungjs/dir-packer.svg?style=flat)](https://travis-ci.org/ungjs/dir-packer)
[![npm version](https://badge.fury.io/js/dir-packer.svg)](http://badge.fury.io/js/dir-packer)


## Installation

```
npm i --save dir-packer
```


## Usage

Packing a directory.

```js
const packer = require('dir-packer');

packer.pack('./src-dir', './result.tar.gz')
  .then(() => console.log('The compression was successfull!'))
  .catch((err) => console.log(err));
```

Unpacking a directory.

```js
const packer = require('dir-packer');

/* will unpack the content of foo.tar.gz to the foo directory */
packer.unpack('./foo.tar.gz', './foo')
  .then(() => console.log('The tar successfully unpacked!'))
  .catch((err) => console.log(err));
```


## License

The MIT License (MIT)