silverstripe-progressivewebapp/README.md

21 lines
636 B
Markdown
Raw Normal View History

2018-06-24 15:51:50 +02:00
# SilverStripe Progressive Web App
Tools to add progressive web app functionality to your silverstripe website
## Installation
```
2018-07-05 18:04:16 +02:00
composer require michelsteege/silverstripe-progressivewebapp
2018-06-24 15:51:50 +02:00
```
## Usage
2018-07-04 12:36:46 +02:00
- Install the module, run dev/build and fill in the settings in the siteconfig
- Include the required js to register the service worker
```
2018-07-05 18:04:16 +02:00
Requirements::javascript('michelsteege/silverstripe-progressivewebapp:resources/js/progressivewebapp.js');
2018-07-04 12:36:46 +02:00
```
- Add the following tags to the head of your website
```
<meta name="theme-color" content="$SiteConfig.ManifestColor">
<link rel="manifest" href="{$BaseHref}manifest.json">
2018-07-05 18:04:16 +02:00
```