aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMartin Fischer <martin@push-f.com>2021-11-19 08:38:57 +0100
committerMartin Fischer <martin@push-f.com>2021-11-19 08:38:58 +0100
commit98ad8cec144900c7799772b3a53241825b416b4f (patch)
tree8a18df3e9ff4c4be5316112c0f02db72f9ef94f2 /README.md
parent7207abccd9dccb15eb37f43a8f763cac99be14d4 (diff)
feature gate named-entities (making phf optional)
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index e5b51be..193b43d 100644
--- a/README.md
+++ b/README.md
@@ -21,6 +21,11 @@ If you want to parse HTML into a tree (DOM) you should by all means use
html5ever, this crate is merely for those who only want an HTML5 tokenizer and
seek to minimize their compile dependencies (html5ever pulls in 56).
+To efficiently resolve named entities like `&amp;` the tokenizer uses
+[phf](https://crates.io/crates/phf) for a compile-time static map. If you
+don't need to resolve named entities, you can avoid the `phf` dependency
+by disabling the `named-entities` feature (which is enabled by default).
+
## Credits
Thanks to the developers of html5ever for their awesome parser!