diff --git a/README.md b/README.md index f6c551f..3362b30 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,27 @@ # Cheaper.com Initial Landing page![Initial Landing page](https://github.com/user-attachments/assets/7d2a1c73-0d16-4965-a2f8-4402ef267ff4) + + + + +##Technical Documentation of how to run the application + +#How to run + +-To run the scraper, execute the main.py script by running the command + +python main.py + +-Make sure you are in the src directory when you run the command (the directory that contains main.py). + +##Where is the entry point? + +-The entry point is the main() in main.py, specifically, this block of code, +if __name__ == "__main__": + main() + + +##what file needs to be located and what variables would need to be changed if you wanted to scrape another website? + +-If you wanted to scrape another website, you need to locate the file main.py and change the variables “scraper” and “pages” to whatever website you wanted and the new URl paths. As well ensure the website allows scraping.