Cheggin/readme-generator
skills/readme-generator/SKILL.md
Auto-generate a README.md with product overview, tech stack, setup instructions, and architecture. Use when the user needs a README for their startup repository, wants to document the project for new developers, or needs to keep the README in sync with the actual project state.
development
Updated Apr 25, 2026
$ install --global
skillsauthnpx skillsauth add Cheggin/skill-chain readme-generatorInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 25, 2026, 8:37 PM12.7s1 file scanned
SKILL.md
- name:
- readme-generator
- description:
- Auto-generate a README.md with product overview, tech stack, setup instructions, and architecture. Use when the user needs a README for their startup repository, wants to document the project for new developers, or needs to keep the README in sync with the actual project state.
- user-invocable:
- true
- group:
- comms
- prerequisites:
- []
- next:
- [documentation-generator, contributing-guide]
- workflows:
- [full-startup]
README Generator
Auto-generate a README.md that stays in sync with the project state. Includes what the product does, the tech stack, how to set up the dev environment, an architecture overview, and how to contribute.
Workflow
1. Extract Product Description
Read the product spec to write a plain-language description of what the product does and who it is for. Keep it to two or three sentences.
2. List Tech Stack
Read project configuration files (package.json, stacks.yml, etc.) to list the tech stack and major dependencies with version numbers and links:
## Tech Stack
- [Next.js 15](https://nextjs.org) - React framework
- [Convex](https://convex.dev) - Backend and database
- [Tailwind CSS 4](https://tailwindcss.com) - Styling
- [Clerk](https://clerk.com) - Authentication
3. Generate Getting Started
Derive step-by-step local dev setup instructions from the actual project setup process:
## Getting Started
1. Clone the repository: `git clone <url>`
2. Install dependencies: `pnpm install`
3. Copy environment variables: `cp .env.example .env.local`
4. Start the dev server: `pnpm dev`
4. Architecture Overview
Describe the high-level system design: how the frontend, backend, database, and external services connect. Include a project structure section explaining key directories and their purpose.
5. Contributing Section
Summarize how agents and humans contribute. Link to CONTRIBUTING.md if it exists.
6. Add Badges and Links
Generate badges for build status, deploy status, and test coverage. Link to the documentation site if the documentation-generator skill is active.
7. Validate and Maintain
Check the README against the actual project state to ensure no stale references (removed scripts, outdated versions, renamed directories). Configure regeneration so the README updates when features are added or the stack changes.
Anti-Patterns
- README with only a project title and no description or setup instructions
- Tech stack section listing "React" without specifying the framework version or related tools
- Setup instructions that reference a script that no longer exists in the repo
- Architecture section that doesn't match the actual project structure
Related Skills
Cheggin/make-interfaces-feel-better
development
VerifiedTrustedCommunity
Design engineering principles for making interfaces feel polished. Use when building UI components, reviewing frontend code, implementing animations, hover states, shadows, borders, typography, micro-interactions, enter/exit animations, or any visual detail work. Triggers on UI polish, design details, "make it feel better", "feels off", stagger animations, border radius, optical alignment, font smoothing, tabular numbers, image outlines, box shadows.
1SKILL.mdUpdated Apr 29, 2026
Cheggin/writer-memory
documentation
VerifiedTrustedCommunity
Agentic memory system for writers - track characters, relationships, scenes, and themes
SKILL.mdUpdated Apr 25, 2026
Cheggin/wiki
documentation
VerifiedTrustedCommunity
LLM Wiki — persistent markdown knowledge base that compounds across sessions (Karpathy model)
SKILL.mdUpdated Apr 25, 2026
Cheggin/website-creation
development
VerifiedTrustedCommunity
Build production-quality SaaS websites with opinionated design presets. Use when creating any startup website. The user MUST pick a design style before building. Enforces shadcn/ui, Figma design principles, specific CSS values per style, and anti-AI-writing. Load alongside anti-ai-writing skill. LIGHT MODE ONLY.
SKILL.mdUpdated Apr 25, 2026