From bc9e5971a68a0906410193a684320a889b23e3b8 Mon Sep 17 00:00:00 2001
From: datechnoman <datechnoman@hotmail.com>
Date: Tue, 12 Dec 2023 10:03:45 +0000
Subject: [PATCH] Upload files to "/"

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..93e9eb9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+<b>Overview:</b>
+
+Use the following scripts to extract urls from .txt.gz files and output to a txt file. 
+
+<b>Requirements:</b>
+<ul>
+  <li>Python3</li>
+</ul>
+ 
+<b>Steps:</b>
+
+1. Git Clone the Repository.
+2. Run url_extractor.py against the directory of txt.gz files you are wanting to process. The script will ask for you to enter the location of the files, where you want to store the output and the concurrency to run the script at.
+3. Once the script has completed running, verify the output of the file.
+
+<b>Notes:</b>
+
+<ul>
+  <li>The script is hardset to stream the txt files from the location and process it line by line migitating the need for large files to be loaded into RAM.</li>
+  <li>Running the script over the network is fine and performance appears to not be impacted. When running against CommonCrawl WAT files it has been identified that a 1Gbit link can be saturated with 12 concurrent processes on an i7. The CPU still has additional capacity.</li>
+</ul>
\ No newline at end of file