From d3716c1bbe1cdfd5b3940ff61c986f3fd1344d33 Mon Sep 17 00:00:00 2001
From: vinayak hegde <vinayakph123@gmail.com>
Date: Wed, 25 Aug 2021 07:11:43 +0530
Subject: [PATCH] Create README.md

---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..96cd72e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# regex-engine
+## Introduction
+A regular expression (shortened as regex or regexp) is a sequence of characters that specifies a search pattern. Regular expressions are extremely useful in 
+extracting information from any text by searching for one or more matches of a specific search pattern 
+(i.e. a specific sequence of ASCII or unicode characters).Usually such patterns are used by string-searching algorithms for
+"find" or "find and replace" operations on strings, or for input validation.
+
+It is a technique developed in theoretical computer science and formal language theory.
+Fields of application range from validation to parsing/replacing strings, passing through translating data to other formats and web scraping.
+
+## Operations supported
+* greedy and non-greedy
+* Support the following macros
+  * []
+	*	a-z
+	*	A-Z
+	*	0-9
+	*	Individual characters and numbers
+  * ^
+  * $
+  * .
+  * ?
+  * \+
+  * \*
+  * \d
+  * \w
+  * \s
+  * escape characters
+
+## Function/Interface supported
+match is the only function supported for the client as an interface. all other functions are not available to the client, they are implementation functions
+(internal static functions)
+### match
+```c
+node_t *match(char *pat, char *text);
+```
+it returns starting and ending position of the string if the substring of text matches with the pattern else returns null.
+
+## Usage
+```
+$ make
+$ ./output 
+```