Document arguments

readme.md

@@ -1,4 +1,4 @@
-# electron-accelerator
+# Electron-accelerator
 
 Get up and running with a customisable electron build process! Supports building, debugging and releasing for Windows, Linux and Mac platforms.
 
@@ -15,17 +15,28 @@ In your project directory.
 ```
 
 Usage: electron-accelerator
+
+This will prompt you to input options.
+You can also supply these at the command line 
+
+Example: electron-accelerator --authorsName=<name>
   
-Required options
+Required options:
 
-platform           all, linux, win32 or darwin
-arch               all, ia32 or x64
+authorsName               any string
+applicationName           any string
+platform                  all, linux, win32 or darwin
+architecture              all, ia32 or x64
+applicationDescription    the description of your application
+applicationRepository     the url of the repository for your application
+setupWindowsReleases      yes, no 
 
-Example            electron-accelerator
+Optional arguments:
 
-Optional options
+squirrelS3Bucket          the bucket name where a windows installer can be uploaded
+squirrelS3BucketPrefix    the bucket prefix
+squirrelWindowsUpdateUrl  the ur that the windows installer will update from
 
-all                equivalent to --platform=all --arch=all
 ```
 
 This will: