Skip to content
This repository has been archived by the owner on Oct 18, 2022. It is now read-only.

Commit

Permalink
chore(readme): expand readme with more info
Browse files Browse the repository at this point in the history
  • Loading branch information
jgw96 committed Dec 19, 2017
1 parent 77d1367 commit 68e2f9b
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,18 @@ To build your PWA for production, run:
```bash
npm run build
```
A production build includes everything needed for your project to be a PWA right out of the box. This includes both a web manifest (src/manifest.json) and a service worker (www/sw.js).
A production build includes everything needed for your project to be a PWA right out of the box. This includes both a Web Manifest (src/manifest.json) and a Service Worker (www/sw.js).


## Service Workers

For info on how Service Workers work in Stencil check out our [Service Worker docs](https://stenciljs.com/docs/service-workers).

## Developing with a Service Worker

In some cases, for instance when you are working on adding [web push notifications](https://developers.google.com/web/fundamentals/push-notifications/) or [background sync](https://developers.google.com/web/updates/2015/12/background-sync), both which require a Service Worker, it can be handy to be able to dev builds with a service worker.

To do this with the Ionic PWA toolkit simply run `npm run devWithSW`. This will start a dev build, but with the Service Worker also getting livereloaded.


## Unit Tests
Expand Down

0 comments on commit 68e2f9b

Please sign in to comment.