Merge pull request #32 from adam-lynch/runinstaller-cb

Small improvements to runInstaller
nwutils · Aug 21, 2014 · 7df3299 · 7df3299
2 parents 32a04aa + 76da4b1
commit 7df3299
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -91,10 +91,14 @@ Will unpack the `filename` in temporary folder.
 
 Callback arguments: error, unpacked directory
 
-### updater:runInstaller(appPath, args, options)
+### updater:runInstaller(apppath, args, options)
 
 Runs installer
 
+`apppath` - String
+`args` - Array of arguments which will be passed when running the new app
+`options` - Optional object 
+
 ### updater:getAppPath()
 
 Returns executed application path

diff --git a/app/updater.js b/app/updater.js
@@ -8,7 +8,7 @@
   // checkNewVersion(cb) - checks new version of app
   // download(cb) - downloads new version in temp
   // unpack(cb) - unpacks the version
-  // runInstaller(cb) - is starting the installer
+  // runInstaller(apppath, args, options) - is starting the installer
   // -------INSTALLER---
   // install(cb) - installs the app in app folder
   // runApp(cb) - starting the app