mcpField
G
generate-readme

generate-readme

github.com/cowork-osDevelopment51450 installsUpdated today
Repository

About generate-readme

generate-readme is a skill for creating or refreshing project README documentation. It produces an onboarding-oriented draft covering setup, usage, and contribution, rather than API docs generated by package tooling.

Key features

  1. 01Create a full README draft
  2. 02Cover setup, usage, and contribution
  3. 03Refresh existing project documentation

Use cases

  1. 01Draft onboarding documentation for a project
  2. 02Update a project README
  3. 03Prepare setup and contribution guidance

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/cowork-os/cowork-os --skill generate-readme

After installing, type/generate-readmein Claude Code to confirm it loaded.

Details

From the project README

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.

Comments

Markdown supported