diff --git a/README.md b/README.md index b9963c5..3277ad0 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,19 @@ Use the following scripts to extract urls from .txt.gz files and output to a txt file. -Depending on the types of URL's that are being processed you will either need to only use "blogger_url_clearner.py" (plainly extract the urls from a file) or also use "blogger_remove_img_lines.py" which will read the txt file and output all lines that do not contain "jpg|png|gif|jpeg" \ No newline at end of file +Depending on the types of URL's that are being processed you will either need to only use "blogger_url_clearner.py" (plainly extract the urls from a file) or also use "blogger_remove_img_lines.py" which will read the txt file and output all lines that do not contain "jpg|png|gif|jpeg" + +Requirements: + + +Steps: + +1. Git Clone the Repository +2. Run blogger_url_cleaner.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. + +Notes: + +The script is hardset to stream the test files from the location and process it line by line migitating the need for large files to be loaded into RAM. \ No newline at end of file