📝md

李昕亮 · 李昕亮 · commit 7957e696cce5 · 2016-12-15T17:00:47.000+08:00
add md
diff --git a/README.md b/README.md
@@ -0,0 +1,120 @@
+
+# html-inline-source-webpack-plugin
+
+> 🔧A webpack plugin to inline source in html, wrapper of inline-source.
+
+## Install
+
+```shell
+$ npm install html-inline-source-webpack-plugin --save-dev
+```
+
+## Usage
+
+#### webpack.config.js
+
+```js
+// webpack.config.js
+let HtmlInlineSourceWebpackPlugin = require('html-inline-source-webpack-plugin');
+
+module.exports = {
+    /* Your config */
+    plugins : [
+        /* ... */
+        new HtmlInlineSourceWebpackPlugin(),
+    ],
+};
+```
+
+#### index.html
+```
+<!DOCTYPE html>
+<html>
+<head>
+    <title> index </title>
+    <link inline href="css/index.css" rel="stylesheet">
+</head>
+<body>
+    <script inline src="js/index.js" charset="utf-8"></script>
+</body>
+</html>
+```
+
+## Notice
+
+```
+<script inline src="js/index.js" charset="utf-8"></script>
+```
+
+* Use `inline` attribute to inline source;
+* Ensure `src` or `href` is linked to a correct file.
+
+## Options
+
+#### Default option
+
+```js
+new HtmlInlineSourceWebpackPlugin()
+```
+
+#### Custom option
+
+This option would apply to all files.
+
+```js
+new HtmlInlineSourceWebpackPlugin({
+    option : {
+        compress : false,
+        rootpath : path.resolve('./dist'),
+    },
+})
+```
+
+#### Custom option for different file
+
+Use `test` to let different option apply to different files.
+
+```js
+new HtmlInlineSourceWebpackPlugin([
+    {
+        test : /\bindex\.html$/,
+        option : {
+            ignore : 'script',
+            rootpath : path.resolve('./dist'),
+        },
+    },
+    {
+        test : /\bexample\.html$/,
+        option : {
+            ignore : 'css',
+            rootpath : path.resolve('./dist'),
+        },
+    },
+    {
+        /* This option would apply to the rest files */
+        option : {
+            ignore : ['script', 'css'],
+            rootpath : path.resolve('./dist'),
+        },
+    },
+])
+```
+
+#### More option
+
+see [here](https://github.com/popeindustries/inline-source#usage).
+
+## Related
+
+* [inline-source](https://www.npmjs.com/package/inline-source)
+    * A plugin to inline source in html. You have to inline source after webpack manually.
+* [html-webpack-inline-source-plugin](https://www.npmjs.com/package/html-webpack-inline-source-plugin)
+    * Depends `html-webpack-plugin`, only inline source in `head` or `body`.
+* [html-inject-webpack-plugin](https://www.npmjs.com/package/html-inject-webpack-plugin)
+    * You have to define flag name in html. Only inline source which is in your `src` directory.
+* [inline-resource-plugin](https://www.npmjs.com/package/inline-resource-plugin)
+    * Only inline source which is in your `src` directory.
+
+## License
+
+MIT
