Skip to content

Commit 2040066

Browse files
authored
Fix: Update README (#3)
* Fix: Update README * bump * Add Performance section
1 parent 0abe112 commit 2040066

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55

66
EmailMinifier is a well-tested email minifier based on TypeScript for browser and Node.js
77

8-
As a quick start, you can [Try it online](https://luckrnx09.github.io/email-minifier/playground) - NOT READY, Welcome to submit a PR 🚀
8+
As a quick start, you can [Try it online](https://luckrnx09.github.io/email-minifier/playground) - NOT READY. Welcome to submit a PR 🚀
99

1010
## Why not HTMLMinifier
1111

12-
EmailMinifier is a great tool for compressing HTML. But email is different from HTML in many ways, compression of HTML is often not the best solution.
12+
[HTMLMinifier](https://github.com/kangax/html-minifier) is a great tool for compressing HTML. But email is different from HTML in many ways, compression of HTML is often not the best solution.
1313
- JavaScript code is not supported or required in emails.
1414
- The interactive behavior of the email is very limited, most HTML attributes are useless for the email but still load them when user open it.
1515
- Some email clients crop oversized emails (e.g. Gmail) and the style of the email is broken after cropping, which is extremely detrimental to marketing.
@@ -89,10 +89,17 @@ const options = {
8989
removeUnusedAttrs: [
9090
new RegExp('custom-test-id') // Remove `custom-test-id` attributes if they not used in style tags
9191
]
92-
}
92+
};
9393
```
9494

9595

9696

97-
# License
97+
## Performance
98+
*TODO: Find some emails, add them to a the project, then minify and list here. Welcome to submit a PR*
99+
100+
| Email | Original Size | Minified Size | Elapsed time |
101+
|--------------------------------|-----------------|---------|------|
102+
|[Example 1](examples/emails/example1.txt)| 0kb | 0kb | 0ms |
103+
104+
## License
98105
See [LICENSE](./LICENSE)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "email-minifier",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"keywords": [
55
"compress",
66
"compressor",

0 commit comments

Comments
 (0)