본문으로 건너뛰기
TakoAPI
스킬로 돌아가기

readme-generator

fratua 제작

Coding Agents & IDEs
526clawskills.sh가 보고한 다운로드 수
0조회수
좋아요 0개로그인하면 이 스킬에 좋아요를 누를 수 있습니다
—아직 평가 없음
내 평가

요약

Generate a production-quality README.md by analyzing project structure, framework, and code.

설명

이 스킬이 하는 일

Analyzes a project's files, dependencies, and structure to produce a complete README.md. Detects the framework, package manager, license, and test setup automatically. Adapts output sections to the specific project type.

Manually writing a README requires cross-referencing package files, inferring commands, and structuring sections by hand — this skill does all of that in one pass.

사용 시점

  • Adding a README to a new open source repo before first publish
  • Onboarding contributors to an undocumented internal tool
  • Generating a README after inheriting a legacy codebase
  • Documenting a CLI tool's flags and usage from source
  • Refreshing an outdated README after major refactors

예시 워크플로

입력

User asks: generate a readme for my project

에이전트
  1. 1

    Reads package.json, pyproject.toml, or other manifests to extract name, description, and dependencies

  2. 2

    Detects framework from dependency signals and config files

  3. 3

    Determines install and run commands from lockfile type and scripts

  4. 4

    Scans for license file, CI workflows, Docker config, and test directories

  5. 5

    Writes a structured README.md with only the sections relevant to the detected project type

출력

README.md written to project root with badges, install instructions, usage examples, and framework-specific sections

설치

clawhub install fratua/readme-generator

CLI 명령을 실행하거나, 프롬프트를 Claude Code, Cursor, Codex 등 사용하는 코딩 에이전트에 붙여넣으세요.

링크