Merge pull request #97 from Menardi/Menardi-patch-1

Add Android overlay support to README

Author: janpio

README.md

@@ -53,34 +53,42 @@ Preferences
 
 #### config.xml
 
--  __StatusBarOverlaysWebView__ (boolean, defaults to true). On iOS 7, make the statusbar overlay or not overlay the WebView at startup.
+-  __StatusBarOverlaysWebView__ (boolean, defaults to true). On iOS, make the statusbar overlay or not overlay the WebView at startup.
 
         <preference name="StatusBarOverlaysWebView" value="true" />
 
-- __StatusBarBackgroundColor__ (color hex string, no default value). On iOS 7, set the background color of the statusbar by a hex string (#RRGGBB) at startup. If this value is not set, the background color will be transparent.
+- __StatusBarBackgroundColor__ (color hex string, no default value). On iOS, set the background color of the statusbar by a hex string (#RRGGBB) at startup. If this value is not set, the background color will be transparent.
 
         <preference name="StatusBarBackgroundColor" value="#000000" />
 
-- __StatusBarStyle__ (status bar style, defaults to lightcontent). On iOS 7, set the status bar style. Available options default, lightcontent, blacktranslucent, blackopaque.
+- __StatusBarStyle__ (status bar style, defaults to lightcontent). On iOS, set the status bar style. Available options default, lightcontent, blacktranslucent, blackopaque.
 
         <preference name="StatusBarStyle" value="lightcontent" />
 
-- __StatusBarDefaultScrollToTop__ (boolean, defaults to false). On iOS 7, allows the Cordova WebView to use default scroll-to-top behavior. Defaults to false so you can listen to the "statusTap" event (described below) and customize the behavior instead.
+- __StatusBarDefaultScrollToTop__ (boolean, defaults to false). On iOS, allows the Cordova WebView to use default scroll-to-top behavior. Defaults to false so you can listen to the "statusTap" event (described below) and customize the behavior instead.
 
         <preference name="StatusBarDefaultScrollToTop" value="false" />
 
 ### Android Quirks
-The Android 5+ guidelines specify using a different color for the statusbar than your main app color (unlike the uniform statusbar color of many iOS 7+ apps), so you may want to set the statusbar color at runtime instead via `StatusBar.backgroundColorByHexString` or `StatusBar.backgroundColorByName`. One way to do that would be:
+The Android 5+ guidelines specify using a different color for the statusbar than your main app color (unlike the uniform statusbar color of many iOS apps), so you may want to set the statusbar color at runtime instead via `StatusBar.backgroundColorByHexString` or `StatusBar.backgroundColorByName`. One way to do that would be:
 ```js
 if (cordova.platformId == 'android') {
     StatusBar.backgroundColorByHexString("#333");
 }
 ```
 
+It is also possible to make the status bar semi-transparent. For example, a black status bar with 20% opacity:
+```js
+if (cordova.platformId == 'android') {
+    StatusBar.overlaysWebView(true);
+    StatusBar.backgroundColorByHexString('#33000000');
+}
+```
+
 Hiding at startup
 -----------
 
-During runtime you can use the StatusBar.hide function below, but if you want the StatusBar to be hidden at app startup, you must modify your app's Info.plist file.
+During runtime you can use the StatusBar.hide function below, but if you want the StatusBar to be hidden at app startup on iOS, you must modify your app's Info.plist file.
 
 Add/edit these two attributes if not present. Set **"Status bar is initially hidden"** to **"YES"** and set **"View controller-based status bar appearance"** to **"NO"**. If you edit it manually without Xcode, the keys and values are:
 
@@ -125,20 +133,21 @@ Events
 StatusBar.overlaysWebView
 =================
 
-On iOS 7, make the statusbar overlay or not overlay the WebView.
+Make the statusbar overlay or not overlay the WebView.
 
     StatusBar.overlaysWebView(true);
 
 Description
 -----------
 
-On iOS 7, set to false to make the statusbar appear like iOS 6. Set the style and background color to suit using the other functions.
+Set to true to make the statusbar overlay on top of your app. Ensure that you adjust your styling accordingly so that your app's title bar or content is not covered. Set to false to make the statusbar solid and not overlay your app. You can then set the style and background color to suit using the other functions.
 
 
 Supported Platforms
 -------------------
 
-- iOS
+- iOS 7+
+- Android 5+
 
 Quick Example
 -------------
@@ -158,7 +167,7 @@ Supported Platforms
 -------------------
 
 - iOS
-- Android 6+ 
+- Android 6+
 - Windows Phone 7
 - Windows Phone 8
 - Windows Phone 8.1
@@ -175,7 +184,7 @@ Supported Platforms
 -------------------
 
 - iOS
-- Android 6+ 
+- Android 6+
 - Windows Phone 7
 - Windows Phone 8
 - Windows Phone 8.1
@@ -192,7 +201,7 @@ Supported Platforms
 -------------------
 
 - iOS
-- Android 6+ 
+- Android 6+
 - Windows Phone 7
 - Windows Phone 8
 - Windows Phone 8.1
@@ -209,7 +218,7 @@ Supported Platforms
 -------------------
 
 - iOS
-- Android 6+ 
+- Android 6+
 - Windows Phone 7
 - Windows Phone 8
 - Windows Phone 8.1
@@ -218,7 +227,7 @@ Supported Platforms
 StatusBar.backgroundColorByName
 =================
 
-On iOS 7, when you set StatusBar.statusBarOverlaysWebView to false, you can set the background color of the statusbar by color name.
+On iOS, when you set StatusBar.overlaysWebView to false, you can set the background color of the statusbar by color name.
 
     StatusBar.backgroundColorByName("red");
 
@@ -248,9 +257,9 @@ CSS shorthand properties are also supported.
     StatusBar.backgroundColorByHexString("#333"); // => #333333
     StatusBar.backgroundColorByHexString("#FAB"); // => #FFAABB
 
-On iOS 7, when you set StatusBar.statusBarOverlaysWebView to false, you can set the background color of the statusbar by a hex string (#RRGGBB).
+On iOS, when you set StatusBar.overlaysWebView to false, you can set the background color of the statusbar by a hex string (#RRGGBB).
 
-On WP7 and WP8 you can also specify values as #AARRGGBB, where AA is an alpha value
+On Android, when StatusBar.overlaysWebView is true, and on WP7&8, you can also specify values as #AARRGGBB, where AA is an alpha value.
 
 Supported Platforms
 -------------------