From 3248264d9082e4fdcac8655323de006913114142 Mon Sep 17 00:00:00 2001
From: Baptiste Jamin <baptiste@crisp.chat>
Date: Mon, 13 Jan 2025 14:24:34 +0100
Subject: [PATCH] Update readme

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index 068d331..6952d15 100644
--- a/README.md
+++ b/README.md
@@ -29,6 +29,12 @@ Install the project using NPM:
 npm install --save email-reply-parser
 ```
 
+## RE2 Support
+
+By default, the library relies on the [RE2](https://github.com/uhop/node-re2) regex engine, which provides better performance and avoids issues like [ReDOS](https://en.wikipedia.org/wiki/ReDoS). By default, RE2 will be installed as a peer dependency.
+
+If you want to explicitly exclude RE2, then `npm uninstall re2`.
+
 ## Features
 
 This library is used at [Crisp](https://crisp.chat/) everyday with around 1 million inbound emails. Over the years, we improved this library so it can work with most emails.