Update README and description
This commit is contained in:
parent
2726f2e454
commit
75ba1a9d01
|
@ -1,6 +1,6 @@
|
||||||
[package]
|
[package]
|
||||||
name = "minify-html"
|
name = "minify-html"
|
||||||
description = "Fast allocation-less HTML minifier with smart whitespace handling"
|
description = "Uncompromisingly fast and smart HTML + JS minifier"
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
homepage = "https://github.com/wilsonzlin/minify-html"
|
homepage = "https://github.com/wilsonzlin/minify-html"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
|
|
23
README.md
23
README.md
|
@ -1,19 +1,22 @@
|
||||||
# minify-html
|
# minify-html
|
||||||
|
|
||||||
A fast one-pass in-place HTML minifier written in Rust with context-aware whitespace handling.
|
Uncompromisingly fast and smart HTML + JS minifier, available for Rust, Node.js, Python, Java, and Ruby.
|
||||||
|
|
||||||
Also supports JS minification by plugging into [esbuild](https://github.com/evanw/esbuild).
|
**Smart**
|
||||||
|
|
||||||
Available as:
|
- Transforms `&am&` to `&am&` which saves 2 bytes but leaves meaning intact, and leaves `≫⃒` encoded because it's longer decoded.
|
||||||
- CLI for macOS and Linux.
|
- Trims and collapses whitespace in `<p>` because it contains text, and removes contiguous whitespace in `<ul>` to allow for inline-block.
|
||||||
- Rust library.
|
- Tries all three attribute value delimiters (`'`, `"`, and none) and picks the shortest, and then removes them if they're the default value based on the spec.
|
||||||
- Native library for Node.js, Python, Java, and Ruby.
|
- References the entire official [entities list](./gen/data/entities.json) and [HTML namespace](./gen/data/react.d.ts) for maximum minification leverage.
|
||||||
|
|
||||||
## Features
|
**Fast**
|
||||||
|
|
||||||
- Minification is done in one pass with no backtracking or DOM/AST building.
|
- Does all of the above in one pass, with zero memory allocations, and works on bytes directly.
|
||||||
- No extra heap memory is allocated during processing, which increases performance.
|
- Uses Rust, SIMD-accelerated memchr, direct tries, and lookup tables.
|
||||||
- Context-aware whitespace handling allows maximum minification while retaining desired spaces.
|
- Written fully in Rust, and natively binds to [esbuild](https://github.com/evanw/esbuild) for super fast JS minification.
|
||||||
|
- Natively binds to Node.js, Python, Java, and Ruby, for fast speed from the comfort of your favourite language.
|
||||||
|
|
||||||
|
**Support**
|
||||||
- Well tested with a large test suite and extensive [fuzzing](./fuzz).
|
- Well tested with a large test suite and extensive [fuzzing](./fuzz).
|
||||||
|
|
||||||
## Performance
|
## Performance
|
||||||
|
|
|
@ -9,7 +9,7 @@
|
||||||
<version>0.2.6</version>
|
<version>0.2.6</version>
|
||||||
|
|
||||||
<name>minify-html</name>
|
<name>minify-html</name>
|
||||||
<description>Fast allocation-less HTML minifier with smart whitespace handling</description>
|
<description>Uncompromisingly fast and smart HTML + JS minifier</description>
|
||||||
<url>https://github.com/wilsonzlin/minify-html</url>
|
<url>https://github.com/wilsonzlin/minify-html</url>
|
||||||
<developers>
|
<developers>
|
||||||
<developer>
|
<developer>
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"name": "@minify-html/js-esbuild",
|
"name": "@minify-html/js-esbuild",
|
||||||
"version": "0.2.6",
|
"version": "0.2.6",
|
||||||
"description": "Fast allocation-less HTML minifier with smart whitespace handling",
|
"description": "Uncompromisingly fast and smart HTML + JS minifier",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"files": [
|
"files": [
|
||||||
"dist/**",
|
"dist/**",
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
[package]
|
[package]
|
||||||
publish = false
|
publish = false
|
||||||
name = "minify_html"
|
name = "minify_html"
|
||||||
description = "Fast allocation-less HTML minifier with smart whitespace handling"
|
description = "Uncompromisingly fast and smart HTML + JS minifier"
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
homepage = "https://github.com/wilsonzlin/minify-html"
|
homepage = "https://github.com/wilsonzlin/minify-html"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
|
|
|
@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
|
||||||
spec.email = ["code@wilsonl.in"]
|
spec.email = ["code@wilsonl.in"]
|
||||||
spec.license = "MIT"
|
spec.license = "MIT"
|
||||||
spec.files = FileList["lib/*", "README.md"].to_a
|
spec.files = FileList["lib/*", "README.md"].to_a
|
||||||
spec.summary = "Fast allocation-less HTML minifier with smart whitespace handling"
|
spec.summary = "Uncompromisingly fast and smart HTML + JS minifier"
|
||||||
spec.homepage = "https://github.com/wilsonzlin/minify_html"
|
spec.homepage = "https://github.com/wilsonzlin/minify_html"
|
||||||
|
|
||||||
spec.require_paths = ["lib"]
|
spec.require_paths = ["lib"]
|
||||||
|
|
Loading…
Reference in New Issue