From ff6c2205d1000c6234e44aa702003490a9d5c0b8 Mon Sep 17 00:00:00 2001
From: Julien Gautier <jgautier.webdev@gmail.com>
Date: Wed, 29 Apr 2026 00:55:26 +0200
Subject: [PATCH] docs: update README with projects decriptions

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++--
 1 file changed, 37 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index f122317..f0e04fe 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,38 @@
-# adastra_scripts
+# AdAstra Scripts
 
-AdAstra Utility Scripts
\ No newline at end of file
+A collection of utility scripts for AdAstra projects. Each script is self-contained and can be used independently.
+
+## Scripts
+
+### MongoDB
+
+| Script | Description |
+|---|---|
+| [`dbdump_mongo/`](dbdump_mongo/) | Backup MongoDB databases with multi-environment support (prod, uat, staging, …) |
+| [`dbrestore_mongo/`](dbrestore_mongo/) | Restore a MongoDB backup with interactive directory navigation |
+| [`dbutils_mongo/`](dbutils_mongo/) | Spin up a local MongoDB + Mongo Express instance via Docker |
+
+#### Typical MongoDB workflow
+
+```bash
+# 1. Backup from a remote MongoDB
+cd dbdump_mongo && ./db-dump.sh dump
+
+# 2. Start a local MongoDB instance
+cd dbutils_mongo && ./db-start.sh up
+
+# 3. Restore the backup locally
+cd dbrestore_mongo && ./db-restore.sh
+```
+
+## Requirements
+
+Each script lists its own requirements in its README. Common dependencies:
+
+- **Bash**
+- **MongoDB Database Tools** (`mongodump` / `mongorestore`) — [download](https://www.mongodb.com/try/download/database-tools)
+- **Docker & Docker Compose** (for `dbutils_mongo` only)
+
+## Author
+
+Julien Gautier — AdAstra