v0.2.0

README.md

@@ -5,13 +5,13 @@
 [![Dependency Status][david-image]][david-url]
 [![devDependency Status][david-dev-image]][david-dev-url]
 
-Pack node.js bin to a standalone executable and pack it in a msi installer (Windows only).
+Package node.js application to a standalone executable and pack it into a msi installer (Windows only).
 
 - Create a binary which does not require node,
 - Pack it in a windows msi installer that:
   - Extract info from package.json such as bin name, provider's name, and so on,
   - Automatically create a license panel in installer from LICENSE/LICENSE.md file, if any,
-  - Automatically create in the windows start menu an entry that contains link to the homepage URL filled in package.json,
+  - Automatically create in the windows start menu an entry that contains link to the homepage URL filled in package.json or provided in cli,
   - Automatically update the PATH environmement variable with the install folder.
 
 ## Prerequisite
@@ -21,6 +21,8 @@ This module has been "tested" with the WIX release 3.11.2.
 
 ## Install
 
+As this module introduces a contraints to both target os and arch (respectively  win32 and x64), install it globally, as an optional dependency or launch it using npx to avoid to constrain your module with these settings.
+
 ```shell
 npm i wix-msi -g
 ```
@@ -35,16 +37,16 @@ wix-msi target_bin
 
 option | desc | value | default
 --- | --- | --- | ---
--l / --license | include license panel in msi installer | boolean | true
+-l / --license | include license panel in msi installer (Done if a LICENSE or LICENSE.md file is found) | boolean | true
 -e / --exe | modify the executable name | string | package.bin[target_bin]
--d / --dir | build folder | path | ./build
--H / --homepage | URL of the shortcut added to menu directory | URL | package.homepage
--i / --ico | Icon displayed in application panel (.ico file) | path | assets/prompt.ico from this module
--b / --banner | Top banner displayed in msi panels (493x58 jpg file) | path | assets/banner.jpg from this module
--B / --background | Background displayed in msi panels (493x312 jpg file) | path | assets/background.jpg from this module
+-d / --dir | build folder | path(*) | ./build
+-H / --homepage | URL of the shortcut added to menu directory (not added if undefined) | URL | package.homepage
+-i / --ico | Icon displayed in application panel (.ico or png file). Note png file will be automatically resized to a 256x256 image | path(*) | assets/prompt.png from this module
+-b / --banner | Top banner displayed in msi panels (493x58 jpeg file with .jpg or .jpeg extension) | path(*) | assets/banner.jpg from this module
+-B / --background | Background displayed in msi panels (493x312 jpeg file with .jpg or .jpeg extension) | path(*) | assets/background.jpg from this module
 -U / --uuid | Product unique identifier | uuid  | automatically generated if not provided (and saved in wixrc file)
 -s / --save | Save settings in .wixrc file | boolean  | n.a.
-
+(*) path must be relative from the execution directory.
 ## Rc file
 
 A .wixrc file could be use to store options:
@@ -53,7 +55,7 @@ A .wixrc file could be use to store options:
 {
   "target-bin": {
     "uuid": "12345678-90ab-cdef-1234-567890abcde",
-    "ico": "./myIcon.ico"
+    "icon": "./myIcon.png"
   }
 }
 ```
@@ -62,15 +64,16 @@ Or will be generated using the -s/--save option.
 
 ## Known Limitations
 
-- Package version should follow the x.y.z format (it does not work with beta/rc or other usual prefix of node module version).
+- Package version should follow the x.y.z format (it does not work with beta/rc or other usual suffix of node module version). If not, the pre-validation step will raise and
+error and stop the packaging.
 
 
 
 ## Versioning
 
 While it's still in beta, version will follow v0.Y.Z, where:
-- Y: Major (could imply breaking changes)
-- Z: Minor or patch
+- Y: Major (could imply breaking changes),
+- Z: Minor or patch.
 
 ## Credits
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "wix-msi",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Package node.js application to a standalone executable (i.e. that does not require node.js installed) and pack it into a msi installer",
   "bin": {
     "wix-msi": "./bin/cli.js"