Skip to content

Commit

Permalink
Add features section in readme, fix headings
Browse files Browse the repository at this point in the history
  • Loading branch information
web-padawan committed Aug 24, 2018
1 parent 4775c2d commit 986b784
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,20 @@ The application uses ES modules for development, and [Webpack](https://webpack.j
a module bundler. The optimizations like code splitting, minifying JavaScript and HTML
(inside of the template string literals) are used to reduce production bundle size.

## Features

- Latest Polymer 3 and up-to-date [webcomponentsjs](https://github.com/webcomponents/webcomponentsjs) polyfill
- UI built using latest [Vaadin components](https://vaadin.com/components) shipped as ES modules
- [Vaadin Router](https://vaadin.com/router) configured for code splitting and lazy loading
- [webpack 4](https://github.com/webpack/webpack) for easy development and production bundling
- Up-to-date [Babel 7](https://github.com/babel/babel) verified to work nice with Custom Elements
- Minification of JavaScript using [babel-preset-minify](https://github.com/babel/minify/tree/master/packages/babel-preset-minify)
- Minification of HTML and CSS in [tagged template literals](https://github.com/goto-bus-stop/babel-plugin-template-html-minifier)
- Automatic service worker generation using [Workbox](https://github.com/GoogleChrome/workbox)
- Automatic [bundle analysis](https://github.com/webpack-contrib/webpack-bundle-analyzer) and report generation
- Web server using [express](https://github.com/expressjs/express) and [History API](https://github.com/bripkens/connect-history-api-fallback) middleware
- Solutions for [building](https://github.com/webpack-contrib/compression-webpack-plugin) and [serving](https://github.com/tkoenig89/express-static-gzip) gzipped files

## Install dependencies

```sh
Expand Down Expand Up @@ -46,14 +60,14 @@ Serve the built output on localhost `http://127.0.0.1:8000`:
npm start
```

## Visualize built output
## Visualize build output

Run production build and start HTTP server to show bundle report:

```sh
npm run build:analyze
```

## Known Limitations
## Known limitations

- Using `import.meta` suggested by Polymer docs is not supported, see [webpack/webpack#6719](https://github.com/webpack/webpack/issues/6719)

0 comments on commit 986b784

Please sign in to comment.