Added update notification and added documentation

Author: sboyina

README.md

@@ -4,49 +4,21 @@ A command line untility to build mobile apps created using WaveMaker product.
 
 The main goal of wm-cordova-cli is to simplify generation of APK or IPA for WaveMaker developers. ```wm-cordova-cli``` combines multiple cordova commands into a single command. First, one has to make sure all the required hardware and software are available and installed. Then execute the command with the appropriate values for arguments.
 
-
-### Cordova versions used for a build 
-1. Based upon the value of 'phonegap-cli' preference value, versions mentioned in the below table are used by default.
-
-| PHONEGAP-CLI | CORDOVA | CORDOVA-ANDROID | CORDOVA-IOS |
-|--|--|--|--|
-| cli-9.0.0 | 9.0.0 | 8.0.0 | 5.1.1 |
-| cli-8.1.1 | 8.1.1 | 7.1.2 | 4.5.5 |
-| cli-8.0.0 | 8.0.0 | 7.0.0 | 4.5.4 |
-
-2. In config.xml, the above cordova values can be overridden by setting preferences with the below mentioned names.
-
-    wm-cordova<br>
-    wm-cordova-android<br>
-    wm-cordova-ios
-
-3. Cordova versions can also be mentioned as command line arguments.
-
-
-
 ## ANDROID build
 
 ### Requirements
 
--   Linux or MAC
-    
--   Latest Android Studio
-    
--   Node 10.x ([https://nodejs.org/en/blog/release/v10.18.0/](https://nodejs.org/en/download/))
-    
--   GIT ([https://git-scm.com/download/mac](https://git-scm.com/download/mac))
-    
--   Java 8
-    
--   Gradle 6
-    
--   KeyStore file for production release builds
-    
--   Install wm-cordova-cli (npm install -g @wavemaker/wm-cordova-cli)
-    
+-   Linux or MAC    
+-   Latest Android Studio    
+-   Node 10.x ([https://nodejs.org/en/blog/release/v10.18.0/](https://nodejs.org/en/download/))    
+-   GIT ([https://git-scm.com/download/mac](https://git-scm.com/download/mac))    
+-   Java 8     
+-   Gradle 6 ([https://gradle.org/releases/](https://gradle.org/releases/))    
+-   KeyStore file for production release builds ([https://developer.android.com/studio/publish/app-signing#generate-key](https://developer.android.com/studio/publish/app-signing#generate-key))    
+-   Install wm-cordova-cli (npm install -g @wavemaker/wm-cordova-cli)    
 -   Make sure JAVA_HOME, ANDROID_SDK and GRADLE_HOME are set in the environment variables and also in PATH.
-    
-
+-   For development build, keystore is optional.
+-   For production build, keystore is required.
 
 
 ### Command
@@ -63,7 +35,7 @@ wm-cordova build android <src_dir> <dest_dir> [additional_arguments]
 |**dest_dir**|**OPTIONAL:** Path to the directory where all build files are to be kept.|
 |**\-\-cordovaVersion**|**OPTIONAL:** Cordova cli version to use|
 |**\-\-cordovaAndroidVersion**|**OPTIONAL:** Version of cordova-ios to use|
-|**\-\-aKeyStore**|Absolute path of the key store. If keystore is not given the, android debug is used.|
+|**\-\-aKeyStore**|Absolute path of the key store. If keystore is not given then android debug key is used.|
 |**\-\-aStorePassword**|Password to key store|
 |**\-\-aKeyAlias**|Alias name of the key|
 |**\-\-aKeyPassword**|Key Password|
@@ -90,22 +62,16 @@ wm-cordova build android "/path/to/src" \
 
 ### Requirements
 
--   MAC machine
-    
+-   MAC machine    
 -   Latest XCODE
-
--   CocoaPods ([https://guides.cocoapods.org/using/getting-started.html#toc_3](https://guides.cocoapods.org/using/getting-started.html#toc_3))
-    
--   Node 10.x ([https://nodejs.org/en/blog/release/v10.18.0/](https://nodejs.org/en/download/))
-    
--   GIT ([https://git-scm.com/download/mac](https://git-scm.com/download/mac))
-    
--   Apple developer or distribution P12 certificates
-    
--   Provisioning profile
-    
+-   CocoaPods ([https://guides.cocoapods.org/using/getting-started.html#toc_3](https://guides.cocoapods.org/using/getting-started.html#toc_3))    
+-   Node 10.x ([https://nodejs.org/en/blog/release/v10.18.0/](https://nodejs.org/en/download/))    
+-   GIT ([https://git-scm.com/download/mac](https://git-scm.com/download/mac))    
+-   Apple developer or distribution P12 certificates    
+-   Provisioning profile    
 -   Install wm-cordova-cli (npm install -g @wavemaker/wm-cordova-cli)
-    
+-   For development build, development certificate and development provisioning file are required.
+-   For production build, distribution certificate and distribution provisioning file are required.
 
 
 
@@ -138,6 +104,30 @@ wm-cordova build ios "/path/to/src" \
 --packageType="production"
 ~~~
 
+
+## Cordova versions used for a build 
+1. Based upon the value of 'phonegap-cli' preference value, versions mentioned in the below table are used by default.
+
+| PHONEGAP-CLI | CORDOVA | CORDOVA-ANDROID | CORDOVA-IOS |
+|--|--|--|--|
+| cli-9.0.0 | 9.0.0 | 8.0.0 | 5.1.1 |
+| cli-8.1.1 | 8.1.1 | 7.1.2 | 4.5.5 |
+| cli-8.0.0 | 8.0.0 | 7.0.0 | 4.5.4 |
+
+2. In config.xml, the above cordova values can be overridden by setting preferences with the below mentioned names.
+
+    wm-cordova<br>
+    wm-cordova-android<br>
+    wm-cordova-ios
+
+3. Cordova versions can also be mentioned as command line arguments.
+
+## Additional Information
+
+1. Destination folder path is logged at the start of the build.
+2. Build log files are present at <destination_folder>/output/logs
+3. The artifact built is available at <destination_folder>/output/<platform_type>/. The complete path is printed in log also.
+
 ## License
 MIT License
 Copyright (c)  2020  WaveMaker

index.js

@@ -1,4 +1,7 @@
 #!/usr/bin/env node
+const updateNotifier = require('update-notifier');
+const pkg = require('./package.json');
+updateNotifier({pkg}).notify();
 const {
     build
 } = require('./src/command');