https://github.com/richardbolt/node-archiver

Super simple module to create a gzipped tar archive of a given path.
https://github.com/richardbolt/node-archiver

Last synced: about 2 months ago
JSON representation

Super simple module to create a gzipped tar archive of a given path.

• Host: GitHub
• URL: https://github.com/richardbolt/node-archiver
• Owner: richardbolt
• License: isc
• Created: 2013-08-12T15:52:01.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2016-06-18T21:19:05.000Z (over 8 years ago)
• Last Synced: 2024-09-24T03:23:43.571Z (3 months ago)
• Language: JavaScript
• Size: 4.88 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Node Archiver

=============

Super simple Node utility to create a gzipped tar archive.

Install

-------

	npm install --save node-archiver

Usage

-----

```javascript

  var archiver = require('node-archiver');

  archiver(__dirname, './dist/my-archive.tar.gz');

```

You can pass an optional callback to archiver:

	

```javascript

archiver(__dirname, './dist/my-archive.tar.gz', function(err) {

  if (err) { throw err; }

  // Done!

});

```

Create an archive in the dist/ directory of your project:

```

./node_modules/node-archiver/bin/create_dist

```

Adding the above line to your build process will create a distributable .tar.gz archive in the dist/ directory of your project. The name of the file will match the name attribute in your `package.json`.

Release Notes

-------------

**0.1.0** Initial Release  

**0.1.1** Bug Fix  

**0.2.0** Added `bin/create_dist` for easier integration into a build process.  

**0.3.0** Dependency updates to latest fstream and tar.