Skip to content

Commit 754fa6b

Browse files
committed
docs: Enhance README with CI/CD badge, updated Python version support, refined architecture descriptions, and an updated release roadmap.
1 parent 06dbf4c commit 754fa6b

2 files changed

Lines changed: 13 additions & 10 deletions

File tree

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
Transform your codebase into an effective knowledge base that provides accurate, relevant context for AI coding assistants—using minimal tokens.
44

5-
[![codecov](https://codecov.io/gh/deepakdgupta1/KnowCode/graph/badge.svg?token=placeholder)](https://codecov.io/gh/deepakdgupta1/KnowCode)
5+
[![codecov](https://codecov.io/gh/deepakdgupta1/KnowCode/graph/badge.svg?token=placeholder)](https://codecov.io/gh/deepakdgupta1/KnowCode) [![CI/CD Pipeline](https://github.com/deepakdgupta1/KnowCode/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/deepakdgupta1/KnowCode/actions/workflows/ci-cd.yml)
6+
67

78
## Overview
89

@@ -112,7 +113,7 @@ knowcode stats [--store <path>]
112113

113114
## Supported Languages (MVP)
114115

115-
- **Python** (.py) - Full AST parsing with functions, classes, methods, calls, imports
116+
- **Python** (.py) - Full AST parsing (Supports Python 3.9 - 3.12)
116117
- **JavaScript / TypeScript** (.js, .ts) - Classes, functions, imports (via tree-sitter)
117118
- **Java** (.java) - Classes, methods, imports, inheritance (via tree-sitter)
118119
- **Markdown** (.md) - Document structure with heading hierarchy
@@ -123,10 +124,10 @@ knowcode stats [--store <path>]
123124
KnowCode follows a layered architecture:
124125

125126
1. **Scanner** - Discovers files with gitignore support
126-
2. **Parsers** - Language-specific parsing (Python AST, Markdown, YAML)
127+
2. **Parsers** - Language-specific parsing (Python AST, Tree-sitter for others)
127128
3. **Graph Builder** - Constructs semantic graph with entities and relationships
128129
4. **Knowledge Store** - In-memory graph with JSON persistence
129-
5. **Context Synthesizer** - Generates token-efficient context bundles
130+
5. **Context Synthesizer** - Generates token-efficient context bundles with priority ranking
130131
6. **CLI** - User interface for all operations
131132

132133
See [KnowCode.md](KnowCode.md) for the complete reference architecture.
@@ -198,11 +199,13 @@ See [KnowCode.md](KnowCode.md) for the full vision. The MVP focuses on:
198199
- ✅ Snapshot-only analysis (no temporal tracking)
199200
- ✅ Local CLI tool
200201

202+
**Released:**
203+
- ✅ v1.1: Additional languages (JavaScript, TypeScript, Java)
204+
- ✅ v1.2: Git history integration, temporal tracking
205+
- ✅ v1.3: Token budget optimization, priority ranking
206+
- ✅ v1.4: Runtime signal integration
207+
201208
**Future releases:**
202-
- v1.1: Additional languages (JavaScript, TypeScript, Java)
203-
- v1.2: Git history integration, temporal tracking
204-
- v1.3: Token budget optimization, priority ranking
205-
- v1.4: Runtime signal integration
206209
- v2.0: Server mode, team sharing, enterprise features
207210

208211
## License

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ build-backend = "hatchling.build"
2525
[tool.hatch.build.targets.wheel]
2626
packages = ["src/knowcode"]
2727

28-
[tool.uv]
29-
dev-dependencies = [
28+
[dependency-groups]
29+
dev = [
3030
"pytest>=7.4",
3131
"ruff>=0.1.5",
3232
"mypy>=1.7",

0 commit comments

Comments
 (0)