diff --git a/README.md b/README.md index 710a05d..1c17342 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,15 @@ Recherche de dépôts GitHub selon des critères, avec une interface web claire résultats (thème clair/sombre, responsive, interface en anglais ou en français). L'interface reprend le style de [Logstream](https://gitea.vlab.bzh/cedric/logstream). -``` -navigateur ──/api/search──▶ searchgit (Go) ──REST──▶ api.github.com/search/repositories - ──/api/saved───▶ ├── cache 5 min - └── planificateur ──▶ /data (instantanés JSON) -``` +## Architecture + +![Schéma d'architecture logique de Searchgit](docs/architecture.svg) + +Le navigateur charge l'interface embarquée dans le binaire Go, puis appelle l'API `/api/*` du +serveur. Le serveur interroge l'API GitHub Search à travers un cache mémoire de 5 minutes ; le +planificateur relance les recherches programmées et enregistre leurs instantanés en JSON dans le +volume `searchgit-data`. Le schéma se modifie dans +[`docs/architecture.excalidraw`](docs/architecture.excalidraw) (excalidraw.com, menu Ouvrir). ## Démarrage rapide