apple-status-bar-webpack-plugin - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "apple-status-bar-webpack-plugin",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Place this after FaviconsWebpackPlugin to override apple status bar",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,1 +0,31 @@
-# AppleStatusBarStyleWebpackPlugin
+# AppleStatusBarWebpackPlugin
+
+If you use the awesome [FaviconWebpackPlugin](https://github.com/jantimon/favicons-webpack-plugin) to generate favion and icons to support android and ios *Add To Home Screen* feature, you will notice the apple status bar style is set to 'black-translucent', which makes it a problem for web apps that have white or light background. You will notice and bar on top of your Web App. This plugin solve this issue.
+
+This plugin **should** be placed after **FaviconsWebpackPlugin** for it it work.
+
+```javascript
+    plugins: [
+      // Enable globals
+      new HtmlWebpackPlugin({
+        title: 'Engage Mobile',
+        template: paths.indexTemplate
+      }),
+
+      new FaviconsWebpackPlugin({
+        logo: path.join(__dirname, '../../static/icons/144x144_360.png'),
+        prefix: 'icons/',
+        icons: {
+          appleStartup: false
+        }
+      }),
+
+      new AppleStatusBarPlugin('black')
+    ]
+```
+
+It's a super simple plugin, all you need to do is spcify the header color in the constructor
+
+```javascript
+  new AppleStatusBarPlugin('black')
+```

No alert changes

Improved metrics

Total package byte prevSize

3047

increased by53.04%

Number of lines in readme file

32

increased by1500%

No dependency changes