Add documentation

kushtrimh · web-flow · commit 8ce5a36d37b0 · 2021-11-03T09:26:44.000+01:00
diff --git a/README.md b/README.md
@@ -1 +1,52 @@
-# java-template-engine-webpack-plugin
+# java-template-engine-webpack-plugin
+
+A plugin extension for [html-webpack-plugin](https://github.com/jantimon/html-webpack-plugin) that injects code for Java template engines.
+
+## Supported engines
+
+- Thymeleaf (`thymeleaf`)
+
+## Installation
+
+`npm i --save-dev java-template-engine-webpack-plugin`
+
+## Usage
+
+```js
+const HtmlWebpackPlugin = require('html-webpack-plugin')
+const JavaTemplateEngineWebpackPlugin = require('java-template-engine-webpack-plugin');
+
+module.exports = {
+  entry: 'index.js',
+  output: {
+    path: __dirname + '/dist',
+    filename: 'bundle.js'
+  },
+  plugins: [
+    new HtmlWebpackPlugin(),
+    new JavaTemplateEngineWebpackPlugin(HtmlWebpackPlugin, {engine: 'thymeleaf'})
+  ]
+}
+```
+
+Adding the plugin for `thymeleaf` in this case, would change the `HTML` as follows
+
+```HTML
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>Webpack App</title>
+    <link rel="stylesheet" th:href="@{styles.css}">
+  </head>
+  <body>
+    <div id="root"></div>
+    <script th:src="@{bundle.js}"></script>
+  </body>
+</html>
+```
+
+### Options
+|Name|Description|
+|--------|---------|
+|`engine`|The engine to be used, please check [supported engines](#supported-engines) section.|
