Saucebox Registry
← Browse

@cowork-os/generate-readme

A

Create a README.md for a project

skillclaude

Install

agr install @cowork-os/generate-readme --target claude

Writes 1 file into .claude/skills/, pinned to git-2eaf376a.

  • .claude/skills/generate-readme/SKILL.md

Document

name: generate-readme description: "Create a README.md for a project"

Generate README

Purpose

Create a README.md for a project

Routing

  • Use when: Use when user asks to generate or refresh project documentation.
  • Do not use when: Don't use for API docs generated by package tooling.
  • Outputs: A full README draft with sections usable for onboarding.
  • Success criteria: Covers setup, usage, and contribution in one coherent document.

Trigger Examples

Positive

  • Use the generate-readme skill for this request.
  • Help me with generate readme.
  • Use when user asks to generate or refresh project documentation.
  • Generate README: provide an actionable result.

Negative

  • Don't use for API docs generated by package tooling.
  • Do not use generate-readme for unrelated requests.
  • This request is outside generate readme scope.
  • This is conceptual discussion only; no tool workflow is needed.

Runtime Prompt

  • Current runtime prompt length: 558 characters.
  • Runtime prompt is defined directly in ../generate-readme.json.

Trustgrade A

  • passBody integrity

    Whether the stored document is plausibly the kind of file the artifact declares, rather than something fetched by mistake.

  • passType matchnot applicable to this artifact type

    Whether the artifact is really the kind of thing its metadata claims it is.

  • passFreshness

    How long since the source repository was last pushed to.

  • passPrompt injection

    Scans the artifact's own text for instructions aimed at your agent rather than at you.

  • passLicense

    Whether the source repository declares an SPDX license permissive enough to redistribute.

How the grade is calculated

Each check contributes 0 points when it passes, 1 when it warns, and 2 when it fails. The total maps to a letter:

  • Aevery check passed
  • Bone warning
  • Ctwo warnings
  • Dprompt injection or body integrity failed, or three warnings
  • Fone of those failed, and something else is wrong

These are automated hygiene checks, not a security audit, and not a dependency or vulnerability scan. A grade of A means nothing was flagged — not that the artifact is safe.

Versions

  • git-2eaf376a9e5b2026-07-31