From 0ac39bfb7bf965bd4423b3368c277b31a08e27cc Mon Sep 17 00:00:00 2001
From: Aadhavan Srinivasan <aadhavan@twomorecents.org>
Date: Thu, 30 Jan 2025 11:19:53 -0500
Subject: [PATCH] Started working on package-level documentation

---
 regex/doc.go | 9 +++++++++
 1 file changed, 9 insertions(+)
 create mode 100644 regex/doc.go

diff --git a/regex/doc.go b/regex/doc.go
new file mode 100644
index 0000000..daa78a3
--- /dev/null
+++ b/regex/doc.go
@@ -0,0 +1,9 @@
+/*
+Package regex implements an NFA-based engine to search for
+regular expressions in strings. The engine does not use backtracking,
+and is therefore not vulnerable to catastrophic backtracking. The regex
+syntax supported (a variation of Golang's) is specified in the Syntax section.
+
+*/
+
+package regex