Lewati ke konten
TakoAPI
Kembali ke skill

readme-generator

oleh fratua

Coding Agents & IDEs
526Unduhan dilaporkan oleh clawskills.sh
0Tayangan
0 sukaMasuk untuk menyukai skill ini
—Belum ada penilaian
Penilaian Anda

Ringkasan

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

Deskripsi

Apa yang Dilakukan Skill Ini

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.

Kapan Menggunakannya

  • 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

Contoh Alur Kerja

INPUT

User asks: generate a readme for my project

AGENT
  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

OUTPUT

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

Instalasi

clawhub install fratua/readme-generator

Jalankan perintah CLI-nya, atau tempel prompt ke Claude Code, Cursor, Codex, atau coding agent apa pun yang Anda pakai.

Tautan