diff --git a/README b/README.md similarity index 62% rename from README rename to README.md index 7e41d1f..a740220 100644 --- a/README +++ b/README.md @@ -1,5 +1,7 @@ -Script will parse a website and find the e-mail addresses using REGEX. -Next release will follow a variable number of links on the website to aide in scanning and entire website rather than one page. +# Email Scraper + +This script will parse the website and find all the e-mail addresses using REGEX. +Next release will follow a variable number of links on the website which will aid in scanning the entire website rather than one page. Usage: Using python 2.7, execute emailScrape.py