README Quick Start 실행 안내 개선

[GunP4ng]

개선 목적

현재 README의 Quick Start 섹션은 프로젝트 실행 순서를 제공하고 있지만, 일부 내용이 실제 저장소 정보와 맞지 않아 처음 사용하는 사용자가 그대로 따라 하기 어렵습니다.

특히 clone 명령어가 예시용 주소로 되어 있어, 사용자가 명령어를 그대로 복사하면 실제 TrendLens 저장소를 받을 수 없습니다.

현재 문제점

현재 Quick Start에는 다음과 같은 예시 주소가 사용되어 있습니다.

git clone https://github.com/yourname/trendlens.git
cd trendlens

하지만 실제 저장소는 GunP4ng/TrendLens이므로, README의 실행 안내가 실제 프로젝트와 일치하도록 수정할 필요가 있습니다.

제안 내용

Quick Start를 아래처럼 수정합니다.

1. 저장소 클론

git clone https://github.com/GunP4ng/TrendLens.git
cd TrendLens

2. 패키지 설치

npm install

3. 환경변수 설정

cp .env.example .env

4. env 파일에 DISCORD_BOT_TOKEN 입력

5. 봇 실행

npm start

그리고 Discord 서버에서 초기 설정하는 흐름도 함께 정리합니다.

/config channel #채널-이름
/apikey set <Gemini-API-키>
/trend

기대 효과

• 처음 방문한 사용자가 README만 보고 바로 실행할 수 있음
• 잘못된 clone 주소로 인한 혼란을 줄일 수 있음
• 프로젝트의 완성도와 신뢰도가 높아짐
• README가 실제 저장소 구조와 일치하게 됨

참고

이 변경은 기능 수정이 아니라 문서 개선 작업입니다.