Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
6 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"name": "Packdir", | ||
"tagline": "Pack specified directory with native OS command line tools.", | ||
"name": "Pack Directory", | ||
"tagline": "Pack specified directory with native OS command line tools (DMG, ZIP with 7z fallback).", | ||
"body": "# PackDir\r\n\r\nPack specified directory with native current OS command line tools.\r\n\r\nMain purpose was to pack the OS X/Windows Electron app,\r\nso Linux was not tested yet.\r\n<br>\r\nBy default, if specified `path` has a `darwin` in it's name,\r\nthe directory will be packed as DMG under OS X.\r\n\r\n## Usage\r\n\r\nGet the package via NPM: `npm install pack-dir`.\r\n\r\n```js\r\nconst Pack = require('pack-dir');\r\n\r\nlet dir = 'some/test/dir';\r\n\r\n// Set custom DMG RegEx, default is `/darwin/`.\r\nPack.param('dmg', /osx/);\r\n\r\n// Pack the directory\r\nPack.path(dir);\r\n```\r\n\r\n### Parameters\r\n\r\n* `dmg` `boolean|RegEx`, check to pack into DMG instead of ZIP.\r\n* `dmgFormat` `string`, the `hdiutil -format` parameter value ([docs](https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man1/hdiutil.1.html)).\r\n* `isSilent` `boolean`, `false`, will write only Errors to console.\r\n* `isSync` `boolean`, `true`, synchronous packaging.\r\n\r\n## Credits\r\n\r\nCreated by [Annexare Studio](https://annexare.com/).\r\nFeel free to use it as you need in your apps or send updates into [this](https://github.com/annexare/PackDir) public repository.\r\nAll code is under MIT license.\r\n\r\n## 7-Zip\r\n\r\nFor Windows host [7-Zip](http://www.7-zip.org/) standalone console app is used\r\n(~1MB, doesn't require installation).\r\nAll license files are included with it, with respect to the author (Igor Pavlov).\r\n", | ||
"note": "Don't delete this file! It's used internally to help with page regeneration." | ||
} |