diff --git a/README.md b/README.md index 56b2f51..5695f7b 100644 --- a/README.md +++ b/README.md @@ -2,5 +2,37 @@ > A **University of Paris-Est Créteil (UPEC)** Semester 6 project. -[English Doc](./docs/README_EN.md) -[French Doc](./docs/README_FR.md) +## Documentation +- 🇬🇧 [English Version](./docs/README_EN.md) +- 🇫🇷 [Version Française](./docs/README_FR.md) + +--- + +## Installation +> Make sure you have **Python 3.10+** installed. + +1. **Clone the repository:** + ```bash + git clone https://github.com/votre-pseudo/millesima-ai-engine.git + cd millesima-ai-engine + ``` + +2. **Set up a virtual environment:** + ```bash + python3 -m venv .venv + source .venv/bin/activate # Windows: .venv\Scripts\activate + ``` + +3. **Install dependencies:** + ```bash + pip install -e . + ``` + +## Usage + +### 1. Data Extraction (Scraping) +To fetch the latest wine data from Millesima: +```bash +python3 src/scraper.py +``` +> Note: that will take some time to fetch all data depending on the catalog size. \ No newline at end of file