Skip to content

docs: README 쉽게 재작성 + 한국어판 + 상세 셋업 가이드#239

Open
seyoung4503 wants to merge 1 commit into
masterfrom
docs/readme-easy
Open

docs: README 쉽게 재작성 + 한국어판 + 상세 셋업 가이드#239
seyoung4503 wants to merge 1 commit into
masterfrom
docs/readme-easy

Conversation

@seyoung4503

Copy link
Copy Markdown
Collaborator

요약

README를 처음 보는 사람도 바로 이해할 수 있게 쉽게 다시 쓰고, 한국어판(README.ko.md) 추가, 디스코드 봇 셋업을 단계별로 상세화했습니다.

변경 내용

  • 쉬운 재서술 — 핵심을 "두 가지(빈 메타데이터 채우기 enrich · 팀마다 다른 정의 federation)"로 정리. 전문용어 최소화.
  • 상세 셋업 가이드 — 봇 생성 → 토큰 → 인텐트 → OAuth 초대 → .env → 실행 → DB 연결 → 사용까지 단계별.
  • 외부 DB 연결 명시/setup(가이드 폼)과 LANG2SQL_DB_URL(전역), 지원 DB(PostgreSQL/MySQL/DuckDB/BigQuery/Snowflake/D1), /connect는 V1 stub임을 안내.
  • 낡은 내용 정정
    • "Does NOT execute against a real database" → SQLAlchemy로 실제 외부 DB 연결되므로 삭제/수정.
    • 로드맵·extensibility의 /semantic show 등 #237에서 제거된 명령 참조 정리.
  • README.ko.md 한국어판 신규 + 영문/국문 상호 링크. 팀·커뮤니티·배지 섹션은 유지.

참고

  • 문서만 변경 (코드 변경 없음).
  • 셋업 가이드는 실제로 봇을 master 기준으로 띄워 검증한 절차를 반영.

🤖 Generated with Claude Code

- 핵심을 '두 가지(enrich·federation)'로 쉽게 재서술
- 디스코드 봇 셋업 단계별 상세화 (봇 생성→토큰→env→실행→DB연결→사용)
- 외부 DB 연결(/setup, LANG2SQL_DB_URL) 및 지원 DB 명시, /connect는 stub임을 안내
- 낡은 내용 정정: 'real DB 미실행' 표현 제거(SqlAlchemy로 실연결), /semantic show 등 삭제 명령 제거
- README.ko.md 한국어판 추가, 영문/국문 상호 링크

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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