From 39f8ccb3769088ce56be85da22dc732462ab54ae Mon Sep 17 00:00:00 2001 From: Kevin Veen-Birkenbach Date: Mon, 7 Apr 2025 14:47:10 +0200 Subject: [PATCH] Update README.md --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0646422..117ce8e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,48 @@ -# docker-volume-cleaner -A Python tool to safely detect and remove unused anonymous Docker volumes. Supports whitelisting, symlink cleanup, and optional confirmation prompts. Ideal for keeping your Docker environment clean and efficient. +# 🧹 Docker Volume Cleaner + +**Docker Volume Cleaner** is a lightweight Python tool that helps you identify and remove unused anonymous Docker volumes β€” including symlinks and their targets πŸ—‘οΈ + +Keep your Docker environment tidy, automated, and efficient πŸš€ + +--- + +## πŸ“¦ Installation + +Install it using [Kevin’s Package Manager](https://github.com/kevinveenbirkenbach/package-manager) with the alias: + +```bash +pkgmgr install dockreap +``` + +> `dockreap` is the alias for this tool within `pkgmgr`. +> Repository: [github.com/kevinveenbirkenbach/docker-volume-cleaner](https://github.com/kevinveenbirkenbach/docker-volume-cleaner) + +--- + +## βš™οΈ Features + +- Detects all anonymous Docker volumes (64-character hashes) +- Skips whitelisted volumes +- Skips bootstrap mounts (`/var/www/bootstrap`) +- Cleans up symlinks **and** their target directories +- Optional confirmation prompt via `--no-confirmation` +- Pure Python β€” **no dependencies** + +--- + +## πŸ“œ License + +This project is licensed under the **MIT License**. + +--- + +## πŸ€– Built with ChatGPT + +Developed with the help of [ChatGPT]([https://chat.openai.com/share/7b177eef-b97f-4e63-b2ef-cfdc69c2337e](https://chatgpt.com/share/67f3c910-2ea0-800f-85db-71ec39a713f2)) 🀝 + +--- + +## πŸ‘€ Author + +**Kevin Veen-Birkenbach** +🌍 [https://www.veen.world/](https://www.veen.world/)