From 6f8c70534465eb7f1b7210664b33bb249a8bbac3 Mon Sep 17 00:00:00 2001 From: Sagar Agarwal Date: Wed, 21 Oct 2026 00:13:13 +0530 Subject: [PATCH] updated readme --- README.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c98170d..8397dd1 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ The generated knowledge lives inside the target project in `.codeintel/` and is ## Why -AI coding agents can lose useful context between sessions and may make incomplete changes when they do not understand the wider system. Project Intelligence gives them a structured, maintainable map of the codebase—with explicit evidence, uncertainty, and refresh guidance. +AI coding agents can lose useful context between sessions and may make incomplete changes when they do not understand the wider system. Codeintel gives them a structured, maintainable map of the codebase—with explicit evidence, uncertainty, and refresh guidance. It is designed to answer questions such as: @@ -169,7 +169,7 @@ Because the knowledge directory is ignored, it is not automatically shared with ## Limitations -Project Intelligence is an analysis workflow, not a guarantee of exhaustive correctness. Results depend on repository access, available tools, execution time, static-analysis capabilities, test setup, and the parts of the code actually inspected. +Codeintel is an analysis workflow, not a guarantee of exhaustive correctness. Results depend on repository access, available tools, execution time, static-analysis capabilities, test setup, and the parts of the code actually inspected. Dynamic dispatch, reflection, generated code, runtime registration, external consumers, and undocumented production behavior may limit certainty. The skill is instructed to record these limitations rather than claim complete coverage. @@ -200,14 +200,6 @@ Dynamic dispatch, reflection, generated code, runtime registration, external con └── LICENSE ``` -### Releasing - -```bash -scripts/validate.sh --bump 1.1.0 # sets the version in every manifest and validates -# update CHANGELOG.md, commit, then: -git tag v1.1.0 && git push --follow-tags -``` - ## Contributing Contributions are welcome. Please see [CONTRIBUTING.md](CONTRIBUTING.md).