docs: flesh out README

2026-08-14 11:24:26 +00:00 · 2026-05-11 20:14:43 +07:00
parent 3161e6bf6e
commit 175135847e
1 changed files with 12 additions and 1 deletions
@@ -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).