Skip to content

docs(readme): v2 아키텍처에 맞게 README 전면 개편#218

Merged
seyoung4503 merged 2 commits intomasterfrom
docs/readme-v2-update
Mar 21, 2026
Merged

docs(readme): v2 아키텍처에 맞게 README 전면 개편#218
seyoung4503 merged 2 commits intomasterfrom
docs/readme-v2-update

Conversation

@seyoung4503
Copy link
Collaborator

Summary

  • v2 모듈러 코어 아키텍처에 맞게 README.md 전면 개편
  • 3개 파이프라인(Baseline/Hybrid/Enriched), Port Protocol, Factory 패턴 등 반영
  • 설치 방법, 퀵스타트, 지원 DB/LLM 목록 업데이트

Test plan

  • README 렌더링 확인
  • 코드 예제 동작 확인

🤖 Generated with Claude Code

seyoung4503 and others added 2 commits March 15, 2026 16:30
- 프로젝트 소개를 v2 모듈러 아키텍처(define-by-run) 기반으로 변경
- Python API 빠른 시작 예시(BaselineNL2SQL) 추가
- 파이프라인 선택 가이드 테이블 추가
- deprecated CLI 옵션 제거 (--database-env, --retriever-name 등)
- 현재 CLI 옵션으로 교체 (--flow, --dialect, --top-n, --no-gate)
- Graph Builder 섹션 제거 (더 이상 존재하지 않음)
- v2 아키텍처 디렉토리 구조 및 설계 원칙 추가
- 지원 환경 섹션 추가 (LLM 7개, DB 12개, VectorDB 3개)
- 기여 가이드를 프로젝트 컨벤션에 맞게 수정 (uv sync, 브랜치 네이밍)
- 레거시 "기여가 필요한 영역" 섹션 제거

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@seyoung4503 seyoung4503 merged commit a9fc276 into master Mar 21, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant