README 생성기
17개 섹션 라이브러리에서 README에 필요한 항목을 고르고, 순서를 바꾸고, 각각을 채워 넣으면 GitHub 스타일 미리보기가 실시간으로 갱신됩니다 — 완성된 README.md를 복사하거나 다운로드하세요.
브라우저에서 완전히 실행됩니다 — 파일이 기기 밖으로 전송되지 않습니다.
여기 있는 모든 것 — 섹션 선택과 내용 — 은 이 브라우저(localStorage)에만 저장되며 어디에도 업로드되지 않습니다. 배지 이미지는 미리보기가 렌더링될 때 브라우저가 shields.io에서 직접 가져옵니다.
사용 방법
- 01기본 섹션 구성(Title, Badges, Installation, Usage, Features, Contributing, License, Acknowledgements)에서 시작하거나, Available 라이브러리에서 Tech Stack, Screenshots, API Reference, Env Variables, FAQ 등 더 많은 섹션을 추가하세요.
- 02Selected 목록에서 섹션을 클릭하면 가운데 열에서 수정할 수 있습니다. 화살표 버튼으로 순서를 바꾸거나 ×로 제거하세요.
- 03각 섹션의 입력 필드를 채우거나, Tech Stack이나 Roadmap처럼 자유 형식인 섹션은 마크다운을 직접 편집하세요.
- 04Badges 섹션을 열어 shields.io 배지를 만드세요 — 라이선스 배지(License 항목에서 선택한 값과 자동으로 연동됩니다), npm 버전, 빌드 상태, PR 환영 배지를 만들 수 있습니다.
- 05오른쪽 미리보기를 확인하거나(원본 마크다운 소스를 보려면 Raw로 전환) 완성된 README.md를 복사하거나 다운로드하세요.
자주 묻는 질문
섹션을 비워두면 어떻게 되나요?
생성된 README에서 완전히 제외됩니다 — 내용 없이 빈 "## Usage" 제목만 남는 일은 없습니다. 자유 형식 섹션(Tech Stack, Roadmap, FAQ 등)도 동일하게 동작합니다: 텍스트 영역을 비우면 해당 섹션이 결과물에서 사라집니다.
실제 LICENSE 파일도 생성해주나요?
아니요, README의 License 섹션에 짧은 안내문과 라이선스 전문 링크만 생성됩니다. 저장소에는 별도로 해당 LICENSE 파일을 추가해야 합니다(같은 선택지 — MIT, Apache 2.0, GPL v3, BSD 3-Clause, MPL 2.0, Unlicense — 중 하나를 GitHub이 대신 추가해줄 수도 있습니다).
Badges 섹션은 어떻게 작동하나요?
작은 shields.io 배지 빌더입니다: 라이선스 배지(기본적으로 License 섹션에서 선택한 값을 따르지만 독립적으로 설정할 수도 있습니다), npm 버전 배지(패키지 이름 입력), 빌드 통과 및 PR 환영 배지, 그리고 선택적인 "Made with MarkdownLab" 배지까지 — 모두 일반 마크다운 이미지 링크로 조립되며 이후 자유롭게 수정할 수 있습니다.
이 내용이 서버로 전송되나요?
아니요. 모든 섹션은 브라우저의 자바스크립트 안에서 전적으로 마크다운으로 조립됩니다. 섹션 선택 내용과 그 안의 내용은 이 브라우저의 로컬 저장소에만 저장되며(새로고침해도 작업 내용이 사라지지 않도록), 어디로도 업로드되지 않습니다. 배지 이미지만은 예외입니다 — 미리보기가 렌더링될 때 shields.io가 직접 이미지를 가져옵니다.
생성한 뒤에도 결과를 계속 수정할 수 있나요?
네 — 복사하거나 다운로드한 뒤 마크다운 에디터(또는 다른 텍스트 편집기)에서 열어 계속 다듬으면 됩니다. 이 생성기는 고정된 템플릿이 아니라 탄탄하고 구조화된 시작점을 제공합니다.