cordova-plugin-android-window-background - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "cordova-plugin-android-window-background",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Plugin to set Android window background for Cordova/Ionic applications",
@@ -5,0 +5,0 @@ "repository": {

README.md

 # :snowflake: cordova-plugin-android-window-background :art: :lollipop:
 
-[![Latest Stable Version](https://img.shields.io/npm/v/cordova-plugin-android-window-background.svg)](https://www.npmjs.com/package/cordova-plugin-android-window-background) [![Total Downloads](https://img.shields.io/npm/dt/cordova-plugin-android-window-background.svg)](https://npm-stat.com/charts.html?package=cordova-plugin-android-window-background) [![License](https://img.shields.io/github/license/winteragency/cordova-plugin-android-window-background.svg)](https://github.com/winteragency/cordova-plugin-android-window-background) [![Made by WINTER](https://img.shields.io/badge/made%20by-WINTER-blue.svg)](https://winter.ax)
+[![Latest Stable Version](https://img.shields.io/npm/v/cordova-plugin-android-window-background.svg)](https://www.npmjs.com/package/cordova-plugin-android-window-background) [![Total Downloads](https://img.shields.io/npm/dt/cordova-plugin-android-window-background.svg)](https://npm-stat.com/charts.html?package=cordova-plugin-android-window-background) [![License](https://img.shields.io/github/license/winteragency/cordova-plugin-android-window-background.svg)](https://github.com/winteragency/cordova-plugin-android-window-background) [![Made by WINTER](https://img.shields.io/badge/made%20by-%E2%9D%84%20WINTER-blue.svg)](https://winter.ax)
 
@@ -10,7 +10,10 @@ This is a simple plugin for Android which will set the window background color for you app's MainActivity to a color of your choice.
 
-    cordova plugin add cordova-plugin-android-window-background
+You'll need to set your desired window background color while installing the plugin by supplying the `WINDOW_BACKGROUND_COLOR` variable. Set it to whatever you want, preferrably the same color as your splash screen.
+
+    cordova plugin add cordova-plugin-android-window-background --variable WINDOW_BACKGROUND_COLOR=#ff69b4 --save
 	
 Or install directly from this repo:
 
-    cordova plugin add https://github.com/winteragency/cordova-plugin-android-window-background.git
+    cordova plugin add https://github.com/winteragency/cordova-plugin-android-window-background.git --variable WINDOW_BACKGROUND_COLOR=#ff69b4 --save
+
 	
@@ -23,7 +26,13 @@ ## Supported Platforms
 
-You must set the `WINDOW_BACKGROUND_COLOR` variable in your app's config.xml to a hex string. This will be added automatically on first install and will be set to #ffffff. Adjust as desired, preferrably setting it to the same background color as your splash screen.
+A custom `WINDOW_BACKGROUND_COLOR` variable will be added to your app's config.xml after installation with the value you selected (provided you included the `--save` flag).
+You can change it whenever you want, but you'll need to remove and re-add the Android platform from your project in order for the change to go through.
 
     <plugin name="cordova-plugin-window-background">
-        <variable name="WINDOW_BACKGROUND_COLOR" value="#ff69b4" />
+        <variable name="WINDOW_BACKGROUND_COLOR" value="#B4D455" />
     </plugin>
+
+To re-add the Android platform:
+
+	cordova platform remove android
+	cordova platform add android
 	
@@ -34,3 +43,4 @@ ## TODO
 - Allow an image background to be used as windowBackground? Perhaps set it to the same image as the splash screen automatically?
-	
+- Find a way to make changes to config.xml automatically update without having to re-add the platform.
+
 ## Thanks / Credits
@@ -37,0 +47,0 @@

No alert changes

Improved metrics

Total package byte prevSize

7498

increased by8.38%

Number of lines in readme file

57

increased by21.28%

No dependency changes