Skip to content

Commit

Permalink
Update docs for PWA template
Browse files Browse the repository at this point in the history
  • Loading branch information
addyosmani committed Jun 1, 2017
1 parent 71188bb commit bcf1b27
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 3 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ If port 8080 is already in use on your machine you must change the port number i
- CSS across all components extracted into a single file and minified with [cssnano](https://github.com/ben-eb/cssnano).
- All static assets compiled with version hashes for efficient long-term caching, and a production `index.html` is auto-generated with proper URLs to these generated assets.
- Use `npm run build --report`to build with bundle size analytics.
- Generates a Service Worker for offline caching your static assets using [sw-precache-webpack-plugin](https://www.npmjs.com/package/sw-precache-webpack-plugin)

- `npm run unit`: Unit tests run in PhantomJS with [Karma](http://karma-runner.github.io/0.13/index.html) + [Mocha](http://mochajs.org/) + [karma-webpack](https://github.com/webpack/karma-webpack).
- Supports ES2015+ in test files.
Expand Down
2 changes: 1 addition & 1 deletion deploy-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ cd _book
git init
git add -A
git commit -m 'update book'
git push -f [email protected]:vuejs-templates/webpack.git master:gh-pages
git push -f [email protected]:vuejs-templates/pwa.git master:gh-pages
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Introduction

This boilerplate is targeted towards large, serious projects and assumes you are somewhat familiar with Webpack and `vue-loader`. Make sure to also read [`vue-loader`'s documentation](http://vuejs.github.io/vue-loader/index.html) for common workflow recipes.
This [Progressive Web Apps](https://developers.google.com/web/progressive-web-apps/) boilerplate is targeted towards large, serious projects and assumes you are somewhat familiar with Webpack and `vue-loader`. Make sure to also read [`vue-loader`'s documentation](http://vuejs.github.io/vue-loader/index.html) for common workflow recipes.

If you just want to try out `vue-loader` or whip out a quick prototype, use the [webpack-simple](https://github.com/vuejs-templates/webpack-simple) template instead.

Expand All @@ -10,7 +10,7 @@ To use this template, scaffold a project with [vue-cli](https://github.com/vuejs

``` bash
$ npm install -g vue-cli
$ vue init webpack my-project
$ vue init pwa my-project
$ cd my-project
$ npm install
$ npm run dev
Expand Down
1 change: 1 addition & 0 deletions docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ All build commands are executed via [NPM Scripts](https://docs.npmjs.com/misc/sc
- HTML minified with [html-minifier](https://github.com/kangax/html-minifier).
- CSS across all components extracted into a single file and minified with [cssnano](https://github.com/ben-eb/cssnano).
- All static assets compiled with version hashes for efficient long-term caching, and a production `index.html` is auto-generated with proper URLs to these generated assets.
- Generates a Service Worker for offline caching your static assets using [sw-precache-webpack-plugin](https://www.npmjs.com/package/sw-precache-webpack-plugin)

### `npm run unit`

Expand Down

0 comments on commit bcf1b27

Please sign in to comment.