From 37ec1f326edc1f3b2171e87c3edd1f3fbef8e5b7 Mon Sep 17 00:00:00 2001 From: JamesKunstle <52969093+JamesKunstle@users.noreply.github.com> Date: Wed, 4 May 2022 14:16:02 -0400 Subject: [PATCH] Update README.md --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 76ac21d..8271ba5 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ -# DocumentCloud Regex Add-On +# DocumentCloud Multiple Regex Add-On -This DocumentCloud Add-On allows you to search through multiple files for a -set of one or more regular expressions, returning a CSV file of matches across -all of the input files. +With this DocumentCloud Add-On one can use multiple Regular Expressions (Regex) as parameters +and find all examples of those patterns in the specified documents. The Regex's are passed as +parameters to the main.py script. + +The output of this add-on is a CSV of all of the incidences of patterns matching text in the +documents specified. ## Files