Skip to content

Commit 5a55d61

Browse files
committed
docs: include package size comparison to documentation
1 parent 77d036d commit 5a55d61

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
11
html-entities
22
=============
33

4-
Fastest HTML entities library.
4+
Fast and lightweight HTML entities library supporting all HTML standards.
55

66
Comes with both TypeScript and Flow types.
77

8+
* [Installation](#installation)
9+
* [Usage](#usage)
10+
* [encode(text, options)](#encodetext-options)
11+
* [decode(text, options)](#decodetext-options)
12+
* [decodeEntity(text, options)](#decodeentitytext-options)
13+
* [Package Size comparison](#package-size-comparison)
14+
* [Performance comparison](#performance-comparison)
15+
816
Installation
917
------------
1018

@@ -116,8 +124,15 @@ Options:
116124
* `html4` uses `HTML4` named references.
117125
* `xml` uses `XML` named references.
118126

119-
Performance
120-
-----------
127+
Package Size comparison
128+
-----------------------
129+
130+
* `html-entities` - 132 kB
131+
* `entities` - 540 kB
132+
* `he` - 124 kB
133+
134+
Performance comparison
135+
----------------------
121136

122137
Statistically significant comparison with other libraries using `benchmark.js`.
123138
Results by this library are marked with `*`.

0 commit comments

Comments
 (0)