Skip to content

docs(readme): v0.3 기능 반영 + 실사용 데모 GIF 추가 - #6

Merged
juunghyun merged 1 commit into
mainfrom
docs/readme-v0.3
Jul 8, 2026
Merged

juunghyun merged 1 commit into
mainfrom
docs/readme-v0.3

Conversation

@juunghyun

Copy link
Copy Markdown
Owner

README가 v0.2 시점 그대로라 bracket 커맨드·schedule 선택 진입·대기 모드·중계 가독성 등 v0.3 기능이 전혀 드러나지 않았고, CLI 내장 help보다 문서가 뒤처져 있었다. 커맨드 목록과 기능 소개를 현행화하고, npm/GitHub 첫 화면에서 실제 사용 모습이 바로 보이도록 오프라인 demo 녹화 GIF를 추가했다.

  • README.md: Usage에 bracket 추가·schedule 설명 현행화(대회 전체+선택 진입), What you get에 가독성 3종·대진표/순위표·대기 모드 bullet 추가, 아키텍처 문단에 standings/bracket/digest 반영, CI·npm 배지와 릴리즈 절차(태그 push 자동 배포) 추가 -> 문서가 CLI 실제 기능과 일치
  • docs/demo.gif (신규, 2.2MB): npx termfc demo --speed 300 실녹화 33초 — 킥오프부터 접기/하이라이트 스트립/경계 블록/골 장면/경기 종료까지 한 컷 -> README 상단에서 사용 경험을 바로 전달, raw.githubusercontent URL 참조라 npmjs.com에서도 렌더됨
  • docs/demo.tape (신규): vhs 녹화 스크립트 -> 데모 UI 바뀔 때 vhs docs/demo.tape 한 번으로 GIF 재생성 가능

테스트: vhs 녹화 후 ffmpeg 프레임 추출(4s/15s/29s/32s)로 접기·스트립·경계 블록·골 장면 육안 확인. 코드 무변경 — CI는 PR에서 기존 스위트 그대로 수행

README가 v0.2 시점 그대로라 bracket 커맨드·schedule 선택 진입·대기 모드·중계 가독성 등 v0.3 기능이 전혀 드러나지 않았고, CLI 내장 help보다 문서가 뒤처져 있었다. 커맨드 목록과 기능 소개를 현행화하고, npm/GitHub 첫 화면에서 실제 사용 모습이 바로 보이도록 오프라인 demo 녹화 GIF를 추가했다.

* README.md: Usage에 bracket 추가·schedule 설명 현행화(대회 전체+선택 진입), What you get에 가독성 3종·대진표/순위표·대기 모드 bullet 추가, 아키텍처 문단에 standings/bracket/digest 반영, CI·npm 배지와 릴리즈 절차(태그 push 자동 배포) 추가 -> 문서가 CLI 실제 기능과 일치
* docs/demo.gif (신규, 2.2MB): npx termfc demo --speed 300 실녹화 33초 — 킥오프부터 접기/하이라이트 스트립/경계 블록/골 장면/경기 종료까지 한 컷 -> README 상단에서 사용 경험을 바로 전달, raw.githubusercontent URL 참조라 npmjs.com에서도 렌더됨
* docs/demo.tape (신규): vhs 녹화 스크립트 -> 데모 UI 바뀔 때 `vhs docs/demo.tape` 한 번으로 GIF 재생성 가능

테스트: vhs 녹화 후 ffmpeg 프레임 추출(4s/15s/29s/32s)로 접기·스트립·경계 블록·골 장면 육안 확인. 코드 무변경 — CI는 PR에서 기존 스위트 그대로 수행
@juunghyun
juunghyun merged commit 26dabc5 into main Jul 8, 2026
2 checks 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