a2hs.js - npm Package Compare versions

Comparing version 0.4.1 to 0.4.2

index.js

@@ -6,3 +6,3 @@ /**
  *
- * a2hs.js v0.4.1 at 10/05/2019
+ * a2hs.js v0.4.2 at 10/05/2019
  *
@@ -31,8 +31,4 @@ * Add to Home Screen
   var padding = settings.padding || "10px";
-  var positionRight = settings.positionRight || 0;
-  var positionBottom = settings.positionBottom || 0;
-  var positionLeft = settings.positionLeft || 0;
   var shadowColor = settings.shadowColor || "#e9e9e9";
   var shadowSize = settings.shadowSize || "10px";
-  var width = settings.width || "100%";
   // Content styles
@@ -78,6 +74,6 @@ var fontFamily = settings.fontFamily || "-apple-system, sans-serif";
         padding: ${padding};
-        right: ${positionRight};
-        bottom: ${positionBottom};
-        left: ${positionLeft};
-        width: ${width};
+        width: 100%;
+        bottom: 0;
+        right: 0;
+        left: 0;
       }
@@ -84,0 +80,0 @@ .a2hs__container .a2hs__logo {

package.json

 {
   "name": "a2hs.js",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "A useful modern JavaScript solution for adding (install) a progressive web application (PWA) to the Home screen of your iOS mobile device.",
@@ -5,0 +5,0 @@ "browserslist": [

README.md

 <h1 align="center">📲 a2hs.js</h1>
-<p align="center"><i>Add progressive web application (PWA) to Home Screen on iOS</i></p>
+<h4 align="center"><i>Add progressive web application (PWA) to Home Screen on iOS</i></h4>
 
 <p align="center">
-    <img src="https://badge.fury.io/js/a2hs.js.svg" alt="npm version"/>
-    <img src="https://img.shields.io/badge/GZip_size-1.9_KB-green.svg?style=flat" alt="gzip"/>
-    <img src="https://data.jsdelivr.com/v1/package/npm/a2hs.js/badge?style=rounded" alt="jsDelivr download"/>
-    <img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat" alt="code style: prettier"/>
-    <img src="https://img.shields.io/badge/license-MIT-yellow.svg?style=flat" alt="license"/>
+  <img width="640px" src="https://user-images.githubusercontent.com/11155743/57543776-fd47ba80-735d-11e9-8c7d-07b0f498b627.jpg" alt="iPhone X mockup a2hs.js"/>
 </p>
 
 <p align="center">
+  <img src="https://badge.fury.io/js/a2hs.js.svg" alt="npm version"/>
+  <img src="https://img.shields.io/bundlephobia/min/a2hs.js.svg?style=flat" alt="bundle size"/>
+  <img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat" alt="code style: prettier"/>
+  <img src="https://img.shields.io/badge/license-MIT-yellow.svg?style=flat" alt="license"/>
+  <img src="https://img.shields.io/twitter/url/https/github.com/koddr/a2hs.js.svg" alt="twit link"/>
+</p>
+
+<p align="center">
     A useful modern JavaScript solution for adding (install) a <b>progressive web application</b> (PWA) to the <b>Home screen</b> of your <b>iOS</b> mobile device. Designed for the <b>latest 4 major versions</b> of iOS Safari 9.x-12.2+.
@@ -38,2 +42,33 @@ </p>
 ```
-<img src="https://user-images.githubusercontent.com/3104648/28352004-a055292c-6c4b-11e7-9c6b-a94cdc2a5458.png" alt="PWA logo"/>
+
+## Options
+
+<p align="center">
+  <img width="560px" src="https://user-images.githubusercontent.com/11155743/57544456-0c2f6c80-7360-11e9-96ec-a4ee59d5bbac.jpg" alt="options example"/>
+</p>
+
+|~|Description|Default|
+|---|---|---|
+|`backgroundColor`|Background color for container|`#f9f9f9`|
+|`padding`|Padding for container|`10px`|
+|`shadowColor`|Shadow color for top of container|`#e9e9e9`|
+|`shadowSize`|Shadow size for top of container|`10px`|
+|`fontFamily`|Font family for content in container|`-apple-system, sans-serif`|
+|`color`|Font color for content in container|`#5d5d5d`|
+|`fontSize`|Font size for content in container|`0.9rem`|
+|`brandName`|Brand for default `htmlContent`|`""`|
+|`logoImage`|Logo for container|[`inline SVG`](https://github.com/koddr/a2hs.js/blob/master/pwa_logo.svg)|
+|`htmlContent`|Content for container with HTML|`Install <strong>{{brandName}} web app</strong> on your iOS device: tap share and <strong>Add to Home Screen</strong> ↓`|
+
+## Demo
+
+<table border="0">
+ <tr border="0">
+   <td width="300px" border="0">
+     <img width="100%" src="https://user-images.githubusercontent.com/11155743/57539303-e2bc1400-7352-11e9-951c-07bb63b4cb61.gif" alt="demo"/>
+   </td>
+   <td border="0">
+     <img src="https://user-images.githubusercontent.com/3104648/28352004-a055292c-6c4b-11e7-9c6b-a94cdc2a5458.png" alt="PWA logo"/>
+   </td>
+ </tr>
+</table>

test/demo/index.js

 var AddToHomeScreen = require("../../");
 
 new AddToHomeScreen({
-  brandName: "Demo",
-  fontFamily: "Tahoma, sans-serif",
-  backgroundColor: "red",
-  color: "white"
+  brandName: "Demo"
 });

No alert changes

Improved metrics

Total package byte prevSize

13686

increased by20.84%

Number of lines in readme file

74

increased by89.74%

Worsened metrics

Lines of code

109

decreased by-6.03%

No dependency changes