Skip to content

docs: reorder Quick Start before Installation, add friendly tone#26

Merged
JunggiKim merged 1 commit intomainfrom
docs/readme-reorder-and-tone
Mar 16, 2026
Merged

docs: reorder Quick Start before Installation, add friendly tone#26
JunggiKim merged 1 commit intomainfrom
docs/readme-reorder-and-tone

Conversation

@JunggiKim
Copy link
Copy Markdown
Owner

Summary

  • Quick Start를 Installation 위로 이동 — "이게 뭐야?" → "어떻게 써?" → "어떻게 설치해?" 순서
  • Installation에 친근한 blockquote 추가: 복사해서 쓰는 것도 환영, 대신 ⭐ 부탁

Test plan

  • GitHub에서 README 렌더링 확인 (blockquote, 이모지, 섹션 순서)

🤖 Generated with Claude Code

- Move Quick Start above Installation to match developer reading flow:
  "what is it?" → "how do I use it?" → "how do I install it?"
- Add lighthearted blockquote acknowledging copy-paste is fine (MIT),
  with a gentle star request
@JunggiKim JunggiKim merged commit 772bafd into main Mar 16, 2026
3 checks passed
@JunggiKim JunggiKim deleted the docs/readme-reorder-and-tone branch March 16, 2026 14:52
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