From 175135847e5cec27c693843d2a8d2699c34f7ae3 Mon Sep 17 00:00:00 2001
From: Tien Nguyen Minh <tiennm99@outlook.com>
Date: Mon, 11 May 2026 20:14:43 +0700
Subject: [PATCH] docs: flesh out README

---
 circular-dependency-checker/README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/circular-dependency-checker/README.md b/circular-dependency-checker/README.md
index f8fdb8e..acc0fe7 100644
--- a/circular-dependency-checker/README.md
+++ b/circular-dependency-checker/README.md
@@ -1,2 +1,13 @@
 # circular-dependency-checker
-Detect cyclic dependencies in Godot, which cause "bad address index". Inspired by https://gist.github.com/tavurth/0d4c49a0a800cbc27f80c3a68f0c8ee7
+
+Detects cyclic dependencies in Godot projects that cause "bad address index" errors.
+
+## Quick start
+
+```bash
+python circular_dependency_checker.py <path-to-godot-project>
+```
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE).