Create Readme
Automatically generates comprehensive README files for GitHub repositories based on project details and code analysis.
Install on your platform
We auto-selected Claude Code based on this skill’s supported platforms.
Run in terminal (recommended)
claude mcp add create-readme npx -- -y @trustedskills/create-readme
Or manually add to ~/.claude/settings.json
{
"mcpServers": {
"create-readme": {
"command": "npx",
"args": [
"-y",
"@trustedskills/create-readme"
]
}
}
}Requires Claude Code (claude CLI). Run claude --version to verify your install.
About This Skill
What it does
The create-readme skill generates a README file tailored to a project, including details like description, usage instructions, and contribution guidelines. It can pull information from existing code or documentation to create a structured and informative README.
When to use it
- You're starting a new project and need a quick, well-formatted README.
- You want to standardize documentation across multiple repositories.
- Your project lacks a README, and you need one generated based on the project's files.
- You're preparing your code for open-source contribution and want to ensure clarity.
Key capabilities
- Automatically generates README content based on project structure.
- Pulls relevant information from existing files or documentation.
- Supports customization of sections like description, usage, and installation instructions.
Example prompts
- "Generate a README for my Python library."
- "Create a README file that includes installation steps and contribution guidelines."
- "Write a README based on the contents of this GitHub repository."
Tips & gotchas
- Ensure your project has enough structure or documentation to allow accurate content generation.
- Review the generated README for accuracy, as it may not capture all nuances of your project.
Tags
TrustedSkills Verification
Unlike other registries that point to live repositories, TrustedSkills pins every skill to a verified commit hash. This protects you from malicious updates — what you install today is exactly what was reviewed and verified.
Security Audits
| Gen Agent Trust Hub | Pass |
| Socket | Pass |
| Snyk | Pass |
🏢 Official
Published by the company or team that built the technology.