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

neo-github-readme-generator

martinforsulu 제작

Git & GitHub
—아직 평가 없음
내 평가

요약

Automatically generates comprehensive README files from GitHub repositories with installation, API docs, and usage.

설명

이 스킬이 하는 일

Analyzes a GitHub repository and generates a README covering installation, usage, API documentation, and code examples. It reads package.json, requirements.txt, code comments, and function signatures to produce structured output. The result is a draft ready for review, not a final published document.

Extracting installation steps, API docs, and usage examples from code directly saves the manual work of cross-referencing multiple files to write them by hand.

사용 시점

  • Documenting a new open-source project before its first release
  • Generating a README for a repo that has none
  • Refreshing outdated documentation by re-analyzing current code
  • Bootstrapping API docs from existing function signatures
  • Creating installation instructions for multi-language projects

예시 워크플로

입력

User asks: Generate a README for https://github.com/user/my-project

에이전트
  1. 1

    Fetch repository structure and file tree via GitHub API

  2. 2

    Parse package.json and requirements.txt for dependencies and scripts

  3. 3

    Scan code comments and function signatures to extract API documentation

  4. 4

    Select matching README template based on project type and language

  5. 5

    Validate the generated README for required sections and completeness

출력

A markdown README file with installation steps, usage examples, and API reference sections populated from the repository contents

요구 사항

  • GitHub personal access token (for private or rate-limited repos)

설치

clawhub install martinforsulu/neo-github-readme-generator

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

링크