generate-readme

star 350

Create a README.md for a project

CoWork-OS By CoWork-OS schedule Updated 2/28/2026

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.
Install via CLI
npx skills add https://github.com/CoWork-OS/CoWork-OS --skill generate-readme
Repository Details
star Stars 350
call_split Forks 51
navigation Branch main
article Path SKILL.md
More from Creator