diff --git a/README.md b/README.md index 4c0f4b8..33d184f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,51 @@ html-webpack-plugin =================== -Generates HTML files to serve your webpack bundles +This is a [webpack](http://webpack.github.io/) plugin that simplifies creation of HTML files to serve your +webpack bundles. This is especially useful for webpack bundles that include +a hash in the filename which changes every compilation. You can either let the plugin generate an HTML file for you or supply +your own template (using [blueimp templates](https://github.com/blueimp/JavaScript-Templates)). + +Installation +------------ +Install the plugin with npm: +```shell +$ npm install html-webpack-plugin --save-dev +``` + + +Basic Usage +----------- + +The plugin will generate an HTML5 file for you that includes all your webpack +bundles in the body. + +For example, this webpack config... +```javascript +{ + entry: { + util: 'util.js', + app: 'index.js' + }, + output: { + path: 'dist', + filename: '[name]_bundle.js' + }, + plugins: [new HtmlWebpackPlugin()] +} +``` + +... generates a file `dist/index.html` containing the following: +```html + + + + + Webpack App + + + + + + +```