diff --git a/README.md b/README.md index 4357d9b..9888c71 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # vite plugin singlefile compression -This plugin compresses all JavaScript, CSS, images, etc. resources using gzip and embeds them into `dist/index.html`, making it convenient to share as a single HTML file. +Compress all assets and embeds them into `dist/index.html`, making it convenient to share as a single HTML file. The recipient can open it directly in the browser without manually unzipping the file. @@ -60,35 +60,35 @@ const router = createRouter({ ```ts export interface Options { - /** - * https://github.com/terser/html-minifier-terser?tab=readme-ov-file#options-quick-reference - * @default defaultHtmlMinifierTerserOptions - */ - htmlMinifierTerser?: htmlMinifierOptions | boolean - - /** - * Try inline html used assets, if inlined or not used in JS. - * @default true - */ - tryInlineHtmlAssets?: boolean - - /** - * Remove inlined asset files. - * @default true - */ - removeInlinedAssetFiles?: boolean - - /** - * Try inline html icon, if icon is in public dir. - * @default true - */ - tryInlineHtmlPublicIcon?: boolean - - /** - * Remove inlined html icon files. - * @default true - */ - removeInlinedPublicIconFiles?: boolean + /** + * https://github.com/terser/html-minifier-terser?tab=readme-ov-file#options-quick-reference + * @default defaultHtmlMinifierTerserOptions + */ + htmlMinifierTerser?: htmlMinifierOptions | boolean; + + /** + * Try inline html used assets, if inlined or not used in JS. + * @default true + */ + tryInlineHtmlAssets?: boolean; + + /** + * Remove inlined asset files. + * @default true + */ + removeInlinedAssetFiles?: boolean; + + /** + * Try inline html icon, if icon is in public dir. + * @default true + */ + tryInlineHtmlPublicIcon?: boolean; + + /** + * Remove inlined html icon files. + * @default true + */ + removeInlinedPublicIconFiles?: boolean; } ``` @@ -113,7 +113,23 @@ dist/index.html 53.60 kB ``` ```html -