Back to skills
SkillHub ClubRun DevOpsFull StackDevOps

readme

When the user wants to create or update a README.md file for a project. Also use when the user says "write readme," "create readme," "document this project," "project documentation," or asks for help with README.md. This skill creates absurdly thorough documentation covering local setup, architecture, and deployment.

Packaged view

This page reorganizes the original catalog entry around fit, installability, and workflow context first. The original raw source lives below.

Stars
133
Hot score
95
Updated
March 20, 2026
Overall rating
C3.6
Composite score
3.6
Best-practice grade
B84.0

Install command

npx @skill-hub/cli install shpigford-skills-readme

Repository

Shpigford/skills

Skill path: readme

When the user wants to create or update a README.md file for a project. Also use when the user says "write readme," "create readme," "document this project," "project documentation," or asks for help with README.md. This skill creates absurdly thorough documentation covering local setup, architecture, and deployment.

Open repository

Best for

Primary workflow: Run DevOps.

Technical facets: Full Stack, DevOps.

Target audience: Development teams looking for install-ready agent workflows..

License: Unknown.

Original source

Catalog source: SkillHub Club.

Repository owner: Shpigford.

This is still a mirrored public skill entry. Review the repository before installing into production workflows.

What it helps with

  • Install readme into Claude Code, Codex CLI, Gemini CLI, or OpenCode workflows
  • Review https://github.com/Shpigford/skills before adding readme to shared team environments
  • Use readme for development workflows

Works across

Claude CodeCodex CLIGemini CLIOpenCode

Favorites: 0.

Sub-skills: 0.

Aggregator: No.