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.
Add this skill
npx mdskills install Shpigford/readmeComprehensive documentation generator with excellent structure and exhaustive coverage across all major project types
Agent Skills for AI coding assistants. These skills follow the Agent Skills Standard and work with Claude Code, Cursor, Gemini Code Assist, GitHub Copilot, and other compatible tools.
npx skills add Shpigford/skills
Or manually:
git clone https://github.com/Shpigford/skills.git ~/.skills/shpigford
| Skill | Description |
|---|---|
| build | Feature development pipeline - research, plan, track, implement |
| chat-widget | Build real-time support chat with floating widget |
| conductor-setup | Configure Rails projects for Conductor |
| favicon | Generate favicon sets from source images |
| issues | Create, list, and view GitHub issues |
| new-rails-project | Create opinionated Rails 8 + React projects |
| readme | Generate comprehensive project documentation |
| screenshots | Generate marketing screenshots with Playwright |
Creates comprehensive README.md documentation for projects. Performs deep codebase exploration before writing, covering:
Triggers: "write readme", "create readme", "document this project", "project documentation"
Example usage:
Write a readme for this project
Feature development pipeline for building major features. Manages a 4-phase workflow:
Subcommands:
/build research [name] Deep research on a feature idea
/build implementation [name] Create phased implementation plan
/build progress [name] Set up progress tracking
/build phase [n] [name] Execute implementation phase n
/build status [name] Show status and next steps
Example workflow:
/build research chat-interface
/build implementation chat-interface
/build progress chat-interface
/build phase 1 chat-interface
Build a real-time support chat system with a floating widget for users and an admin dashboard for support staff.
Features:
Includes:
Triggers: "add a live chat widget", "build customer support chat", "create real-time messaging"
Example usage:
Add a live chat widget to the app
Configure a Rails project to work with Conductor, the Mac app for parallel coding agents. Creates:
conductor.json - Project configurationbin/conductor-setup - Setup script for worktreesscript/server - Server script with port/Redis isolationENV['REDIS_URL']Example usage:
Set up this project for Conductor
Generate a complete set of favicons from a source image. Auto-detects project type (Rails, Next.js, Vite, static HTML, etc.) and places files in the correct location.
Generates:
favicon.ico (multi-resolution: 16x16, 32x32, 48x48)favicon-96x96.pngapple-touch-icon.png (180x180)web-app-manifest-192x192.pngweb-app-manifest-512x512.pngsite.webmanifestfavicon.svg (if source is SVG)Requires: ImageMagick v7+ (brew install imagemagick)
Example usage:
/favicon logo.png
/favicon assets/icon.svg
Interact with GitHub issues using the gh CLI. Create, list, and view issues with guided prompts.
Actions:
Requires: GitHub CLI (gh) authenticated
Example usage:
/issues
Create a new Rails project with an opinionated modern stack:
Includes testing setup (minitest, mocha, VCR) and code quality tools (RuboCop, Brakeman).
Example usage:
/new-rails-project my-app
Generate marketing-quality screenshots of your app using Playwright. Captures at true HiDPI (2x retina) resolution.
Features:
Requires: Playwright (npm install -D playwright)
Example usage:
/screenshots http://localhost:3000
Generate screenshots for Product Hunt
These skills work with any Agent Skills Standard-compatible tool:
MIT
Install via CLI
npx mdskills install Shpigford/readmeSkills is a free, open-source AI agent skill. 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.
Install Skills with a single command:
npx mdskills install Shpigford/readmeThis downloads the skill files into your project and your AI agent picks them up automatically.
Skills works with Claude Code, Claude Desktop, Cursor, Vscode Copilot, Windsurf, Continue Dev, Codex, Gemini Cli, Amp, Roo Code, Goose, Opencode, Trae, Qodo, Command Code, Factory. Skills use the open SKILL.md format which is compatible with any AI coding agent that reads markdown instructions.