Skip to content

Commit

Permalink
update readme & node requirement
Browse files Browse the repository at this point in the history
  • Loading branch information
jbdemonte committed Mar 1, 2018
1 parent ae12dfa commit 3857168
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 9 deletions.
1 change: 0 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ node_js:
- "9"
- "8"
- "7"
- "6"

script:
- yarn test --coverage
Expand Down
25 changes: 18 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
Node p7zip wrapper
==================

A node wrapper for 7z including the latest version of `7za`.
[![travis build](https://img.shields.io/travis/jbdemonte/node-p7zip.svg)](https://travis-ci.org/jbdemonte/node-p7zip)
[![Coverage Status](https://coveralls.io/repos/github/jbdemonte/node-p7zip/badge.svg?branch=master)](https://coveralls.io/github/jbdemonte/node-p7zip?branch=master)
[![NPM Version](https://img.shields.io/npm/v/p7zip.svg)](https://www.npmjs.com/package/p7zip)
![node (tag)](https://img.shields.io/node/v/p7zip/latest.svg)


A node wrapper for p7zip including the latest version of `7za`.

Limitation
----------

Because p7zip is a portage of 7-zip for linux systems, this package is not usable on Windows.

Description
-----------
Expand Down Expand Up @@ -63,7 +74,7 @@ API
**Arguments**
* `archive` The archive path.
* `files` The file list to add (string or array of string).
* `switches` Switches (array of string).
* `switches` Switches (string or array of string).

**Returns**
* `count` The file count added.
Expand All @@ -74,7 +85,7 @@ API
**Arguments**
* `archive` The archive path.
* `files` The file list to delete (string or array of string).
* `switches` Switches (array of string).
* `switches` Switches (string or array of string).

**Returns**
* none
Expand All @@ -88,7 +99,7 @@ Default overwrite mode is set to "Overwrite All existing files without prompt" u
* `archive` The archive path.
* `destination` The extraction path (optional).
* `fileFilter` File filters to extract (string or array of string, optional).
* `switches` Switches (array of string).
* `switches` Switches (string or array of string).
* `full` Extract with full paths (optional, default=true).

**Returns**
Expand All @@ -99,7 +110,7 @@ Default overwrite mode is set to "Overwrite All existing files without prompt" u

**Arguments**
* `archive` The archive path.
* `switches` Switches (array of string).
* `switches` Switches (string or array of string).

**Returns**
* `data` object
Expand All @@ -126,7 +137,7 @@ Default overwrite mode is set to "Overwrite All existing files without prompt" u
**Arguments**
* `archive` The archive path.
* `files` Hashmap of the file list to rename ({oldName: newName, ...}.
* `switches` Switches (array of string).
* `switches` Switches (string or array of string).

**Returns**
* none
Expand All @@ -136,7 +147,7 @@ Default overwrite mode is set to "Overwrite All existing files without prompt" u
**Arguments**
* `archive` Path to the archive.
* `files` The file list to update (string or array of string).
* `switches` Switches (array of string).
* `switches` Switches (string or array of string).

**Returns**
* `count` The file count updated.
6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
{
"name": "p7zip",
"version": "2.3.0",
"version": "3.0.0",
"description": "A node wrapper for 7z including latest version of 7za",
"main": "index.js",
"os" : [ "darwin", "linux" ],
"engines": {
"node": ">= 7.0.0"
},
"scripts": {
"test": "jest",
"install": "node scripts/install.js"
Expand Down

0 comments on commit 3857168

Please sign in to comment.