diff --git a/README.md b/README.md index 682c381..f4fb94b 100644 --- a/README.md +++ b/README.md @@ -1 +1,24 @@ -# Marketscrape \ No newline at end of file +# Marketscrape +Marketscrape is a user-friendly web scraper for Facebook Marketplace that utilizes AI to help users assess the value of each listing, and by providing real-time analysis and advanced machine learning algorithms, it empowers users to make informed purchasing decisions and find the best deals on Facebook Marketplace. + +## Installation +Clone the repository +```bash +$ https://github.com/Marketscrape/marketscrape.git +``` + +### Local setup using Docker +- First, install [docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/). +- Next, run the following command to start the container. + +```bash +$ docker compose up +``` + +Note that when you run it for the first time, it will download a docker image of size 4.5GB or so. + +- Finally, when your done running the project run the following command to shut down the containers. + +```bash +$ docker compose down +```