From 0d41796ee18c60bab90445b93affcdfb31e216d8 Mon Sep 17 00:00:00 2001
From: spham <sylvain@pham.es>
Date: Sun, 8 Jun 2025 00:20:00 +0200
Subject: [PATCH] Ajout du fichier README.md avec description du projet

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c462162
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# FastAPI Project
+
+API REST développée avec FastAPI pour la gestion et la prédiction de modèles de machine learning.
+
+## Fonctionnalités
+
+- API REST avec documentation automatique (Swagger UI)
+- Endpoints pour la prédiction de modèles ML
+- Validation des données avec Pydantic
+- Documentation complète avec MkDocs
+
+## Documentation
+
+Consultez le dossier `docs/` pour la documentation complète du projet, ou générez-la avec MkDocs :
+
+```bash
+mkdocs build
+mkdocs serve  # Pour prévisualiser localement
+```
+
+## Démarrage rapide
+
+```bash
+# Installation des dépendances
+pip install -r requirements.txt
+
+# Lancement du serveur
+uvicorn main:app --reload
+```
+
+Accédez à l'API via http://localhost:8000 et à la documentation via http://localhost:8000/docs