@pwabuilder/pwainstall - npm Package Compare versions

Comparing version 0.8.0 to 0.9.0

package.json

 {
   "name": "@pwabuilder/pwainstall",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "",
@@ -5,0 +5,0 @@ "main": "dist/pwa-install.js",

README.md

 # pwa-install
 
-`<pwa-install />`
+`pwa-install` is a [web component](https://meowni.ca/posts/web-components-with-otters/) from the [PWABuilder](https://pwabuilder.com) team that brings an awesome "install" experience to your Progressive Web App!
 
-pwa-install is a web component built with [lit-element](https://lit-element.polymer-project.org/) that brings an awesome install experience to your Progressive Web App! It is still early, but expect lots of improvements soon!
+_Built with [lit-element](https://lit-element.polymer-project.org/)_
+
+### What does it look like?
+
+![An image of what the component looks like](assets/installsnip.png?raw=true "pwa-install")
+
+## Using this component
+
+## Install
+
+There are two ways to use this component. For simple projects or just to get started fast, we recommend using the component by script tag. If your project is using [npm](https://www.npmjs.com/) then we recommend using the npm package.
+
+### Script tag
+
+- Put this script tag in the head of your index.html:
+
+```html
+<script
+  type="module"
+  src="https://cdn.jsdelivr.net/npm/@pwabuilder/pwainstall"
+></script>
+```
+
+### NPM
+
+- Run `npm install @pwabuilder/pwainstall`
+- import with `import '@pwabuilder/pwainstall`
+
+Then you can use the element `<pwa-install></pwa-install>` anywhere in your template, JSX, html etc. An example of using this component can be found here: https://glitch.com/~pwainstall
+
+## API
+
+### Properties
+
+| Property       | Attribute      | Description                     | Type      | Default         |
+| -------------- | -------------- | ------------------------------- | --------- | --------------- |
+| `showopen`     | `showopen`     | Will always show install button | `boolean` | `false`         |
+| `manifestpath` | `manifestpath` | path to your web manifest       | `string`  | `manifest.json` |
+
+### Methods
+
+| name         | Description               |
+| ------------ | ------------------------- |
+| `openPrompt()` | `Opens the install modal` |

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

524974

increased by46.39%

Number of package files

17

increased by6.25%

Number of lines in readme file

49

increased by880%

Number of medium supply chain risk alerts

2

decreased by-33.33%

No dependency changes