Docs: Tweak readme a bit

sapegin · sapegin · commit 3ea37d2767d7 · 2018-03-30T13:46:57.000+02:00
diff --git a/README.md b/README.md
@@ -1,8 +1,10 @@
-# mini-html-webpack-plugin - A miniature version of html-webpack-plugin with less functionality
+# mini-html-webpack-plugin: a miniature version of html-webpack-plugin with only necessary features
 
 [![npm](https://img.shields.io/npm/v/mini-html-webpack-plugin.svg)](https://www.npmjs.com/package/mini-html-webpack-plugin) [![Build Status](https://travis-ci.org/styleguidist/mini-html-webpack-plugin.svg)](https://travis-ci.org/styleguidist/mini-html-webpack-plugin)
 
-The plugin writes CSS and JS asset paths for you automatically. You can also override most of it. It does **not** work with html-webpack-plugin plugins!
+The plugin writes CSS and JS asset paths for you automatically. Works with webpack 3 and 4.
+
+**It does not work with html-webpack-plugin plugins!**
 
 ## Usage
 
@@ -17,15 +19,15 @@ const config = {
   plugins: [
     new MiniHtmlWebpackPlugin({
       context: {
-        title: 'Webpack demo' // Available in the context below
+        title: 'Webpack demo'
       },
       filename: 'demo.html' // Optional, defaults to `index.html`
     })
   ]
 };
 ```
 
-## How to Minify HTML?
+### HTML minification
 
 ```javascript
 const minify = require('html-minifier').minify;
@@ -44,7 +46,7 @@ const config = {
 };
 ```
 
-## Custom Templates
+### Custom templates
 
 Use [@vxna/mini-html-webpack-template](https://www.npmjs.com/package/@vxna/mini-html-webpack-template) to add an app container div, a favicon, meta tags, inline JavaScript or CSS.
 
@@ -61,7 +63,7 @@ const config = {
   plugins: [
     new MiniHtmlWebpackPlugin({
       context: {
-        title: 'Custom template'
+        title: 'Custom template' // Available in the context below
       },
       template: ({ css, js, title, publicPath }) =>
         `<!DOCTYPE html>
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "mini-html-webpack-plugin",
   "version": "0.0.0-development",
-  "description": "A miniature version of html-webpack-plugin with less functionality",
+  "description": "A miniature version of html-webpack-plugin with only necessary features",
   "main": "index.js",
   "files": [
     "index.js"

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "mini-html-webpack-plugin",`
`3`	`3`	`"version": "0.0.0-development",`
`4`		`- "description": "A miniature version of html-webpack-plugin with less functionality",`
	`4`	`+ "description": "A miniature version of html-webpack-plugin with only necessary features",`
`5`	`5`	`"main": "index.js",`
`6`	`6`	`"files": [`
`7`	`7`	`"index.js"`