ssp-artichoke
v0.1.0
Published
Unix archiver (ar) implementation with Node.js
Downloads
2
Readme
artichoke
:package: Unix archiver (ar) implementation with Node.js.
Install
npm install ssp-artichoke --production
Tests
If you want to run the tests, install without --production
flag
and then install Mocha and standard globally:
npm install -g mocha
npm install -g standard
Then run tests with:
npm test
Usage
'use strict'
const artichoke = require('ssp-artichoke')
let options = {native: true, verbose: false}
artichoke.createArchive('my_archive.ar', ['package.json', 'GPL-LICENSE', 'MIT-LICENSE'], options)
The omittable options object has parameters to force use of the native add-on (i.e. prompt a message on fallback) and whether to use verbose output on creation of archive.
Other requirements
If you wish to make use of the native-addon. Your system will need:
- node-gyp
- Python 2.7+ (not 3.0+)
- A C++11 compiler (e.g. g++ 4.8+)
License
Artichoke is dual licensed under the GNU General Public License and MIT licenses respectively.