Generate, edit, and improve README.md files with badges and multi-language support.
npx skills add https://github.com/AstyanM/claude-am-plugin --skill readme-editor
Please help me install this Agent Skill. Skill: readme-editor Source: https://github.com/AstyanM/claude-am-plugin/tree/main/skills/readme-editor Command: npx skills add https://github.com/AstyanM/claude-am-plugin --skill readme-editor
This Skill addresses the challenge of creating and maintaining high-quality, comprehensive README.md files. It automates the process of generating new READMEs, updating existing ones, and ensuring they adhere to best practices, saving developers time and ensuring consistent project documentation.
README.md from scratch, incorporating project details like features, tech stack, installation guides, and license information by analyzing the codebase.README.md for a project, ensuring it follows best practices and includes all necessary sections like installation, features, and tech stack. Or, an existing README needs to be updated with new badges and a table of contents.Use the readme-editor skill to generate a comprehensive README.md for my new project.
High-intent search queries and answers about installing and using this skill.
Generate a README.md by analyzing the codebase to automatically extract project details, tech stack, and installation guides. The skill applies canonical patterns to structure features and license information professionally.
Update an existing README.md by intelligently editing the content to add missing sections, dynamic badges, and a table of contents. It restructures outdated information for clarity and applies best practices.
Create bilingual README.md files using built-in multi-language support that ensures accurate and natural translation for technical documentation. It analyzes codebase context to maintain consistent project descriptions across languages.
Codebase analysis improves project documentation by automatically extracting features, dependencies, and structural patterns to populate the README. This ensures the generated content accurately reflects the actual codebase context.
Ensure your README follows best practices by applying a detailed quality assurance checklist that verifies links, code blocks, and version numbers. Canonical README patterns are applied to validate overall content accuracy before finalization.
Readme-editor works entirely without external dependencies, using internal references to analyze codebase context and apply canonical README patterns. This allows standalone generation and refinement of markdown documentation.
Greenmamba29Generate comprehensive README.md files by analyzing codebase structure and dependencies.
copilot-ldRender Markdown documentation into static HTML sites with Mustache templates.
auldsyababuaValidate Markdown files for syntax, links, and formatting standards.
KrystianYCSilvaCreate Markdown documentation with Mermaid diagrams and GFM tables.