silverstripe-progressivewebapp/README.md

# 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 (<link rel="manifest" href="{$BaseHref}manifest.json">) in the head of your pages and add the color meta data as well (<meta name="theme-color" content="$SiteConfig.ManifestColor">)
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
First commit 2018-06-24 15:51:50 +02:00			`# 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`
Service worker 2018-06-25 14:19:45 +02:00			`Create a symlink at the root of you website to vendor/pixelspin/silverstripe-progressivewebapp/service-worker.js`
Readne 2018-06-24 18:28:15 +02:00			`Place the link to the manifest file (<link rel="manifest" href="{$BaseHref}manifest.json">) in the head of your pages and add the color meta data as well (<meta name="theme-color" content="$SiteConfig.ManifestColor">)`
			`Include the js (Requirements::javascript('pixelspin/silverstripe-progressivewebapp:resources/js/progressivewebapp.js');)`

			`## Todo`
Update README.md 2018-06-24 18:50:43 +02:00			`- Add "add to homescreen" prompt`
			`- Add offline support`
			`- Create an you are offline page`
			`- Improve documentation`