silverstripe-progressivewebapp/README.md

855 B

SilverStripe Progressive Web App

Tools to add progressive web app functionality to your silverstripe website

Installation

composer require pixelspin/silverstripe-progressivewebapp

Usage

Install the module, run dev/build and fill in the settings in the siteconfig Create a symlink at the root of you website to vendor/pixelspin/silverstripe-progressivewebapp/service-worker.js Place the link to the manifest file () in the head of your pages and add the color meta data as well () Include the js (Requirements::javascript('pixelspin/silverstripe-progressivewebapp:resources/js/progressivewebapp.js');)

Todo

  • Add "add to homescreen" prompt
  • Add offline support
  • Create an you are offline page
  • Improve documentation