diff --git a/README.md b/README.md index 9694654..3fd1ef8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,12 @@ # add2homescreen -add2homescreen detects if your website is being opened on iOS or Android and offers on-screen instructions to add your website as a webapp to users' homescreens. +add2homescreen is an easy way to integrate PWA (progressive web app) support to your website. +add2homescreen detects if your website is being opened on iOS or Android and offers users on-screen instructions on how to add your website to their smartphone's homescreens. ![image](https://raw.githubusercontent.com/KevDoy/add2homescreen/main/preview.jpg) + +## Getting started + +1. Clone the repository +2. Copy the add2homescreen folder (which contains add2homescreen.js, android-notice.svg, appicon.png, config.js, ios-notice.svg) to the root folder of your site. +3. Copy and paste the labeled snippet from code.html and paste it into the of your website. +4. Enjoy