[FEATURE] 프로젝트 README 문서 개선 by YUNCHANGHYEOK · Pull Request #3 · Plain-Insight/plain_ai

YUNCHANGHYEOK · 2025-10-03T08:05:32Z

개요

프로젝트 소개 및 사용법을 체계적으로 문서화했습니다.

프로젝트 개요 개선
- 명확한 프로젝트 목적 및 목표 설명
- GitHub 배지 추가 (이슈, 스타, 라이선스)
- 프로젝트 설명을 더 전문적으로 작성
설치 가이드 작성
- 단계별 설치 과정 명시
- 가상환경 설정 가이드 포함
- 개발 도구 설치 안내
사용법 가이드 추가
- 기본 실행 방법
- 개발 모드 실행
- 테스트 실행 방법
개발 워크플로우 가이드
- 새 기능 개발 프로세스
- 브랜치 전략 설명
- 커밋 규칙 명시

Closes #2

- 프로젝트 개요 및 목적 명확히 설명 - 설치 가이드 단계별 작성 - 사용법 예시 추가 (기본/개발/테스트 모드) - Git 워크플로우 가이드 추가 - 프로젝트 구조 및 기술 스택 명시 - 기여 가이드라인 작성 Closes #2

- 실제 사용한 GitHub CLI 명령어만 포함 - 커밋-브랜치-이슈 연동 방법 명시 - 복잡한 설명 제거하고 핵심만 정리 Part of #2

- hello.py 개발 예시를 포함한 완전한 워크플로우 추가 - 자동화 스크립트 예시 제공 - 기여 가이드 간소화 및 정리 Part of #2

yoon added 4 commits October 3, 2025 17:05

[DOCS] #2 이슈 기반 개발 워크플로우 간단 가이드

15b5f69

- 실제 사용한 GitHub CLI 명령어만 포함 - 커밋-브랜치-이슈 연동 방법 명시 - 복잡한 설명 제거하고 핵심만 정리 Part of #2

[DOCS] #2 이슈 기반 개발 워크플로우 간단 가이드 추가

37c3d68

[DOCS] #2 README 완전한 워크플로우 가이드 완성

5a59f28

- hello.py 개발 예시를 포함한 완전한 워크플로우 추가 - 자동화 스크립트 예시 제공 - 기여 가이드 간소화 및 정리 Part of #2