Generate ClearDocs-compliant README files from detected project metadata.
npx skills add https://github.com/montymi/claude-config --skill readme-montymi
Please help me install this Agent Skill. Skill: readme Source: https://github.com/montymi/claude-config/tree/main/skills/readme Command: npx skills add https://github.com/montymi/claude-config --skill readme-montymi
Create or update a README.md for a project following ClearDocs styling principles, reducing manual drafting and ensuring consistency across repos.
Run the Readme Skill on your project repository to generate a ClearDocs-compliant README.
High-intent search queries and answers about installing and using this skill.
Generate a ClearDocs-compliant README by running the readme Skill on your repository, which auto-detects project metadata and applies a standardized markdown template to produce clear documentation fast.
Automatic project documentation detects environment variables and license visibility by scanning repository assets like LICENSE files and configuration, conditionally including those sections in the generated README based on what is actually found.
Yes, the markdown README generator applies to software projects of varying sizes and languages, auto-detecting project metadata to populate the documentation sections accurately regardless of the specific tech stack.
Update an existing README without losing details by using a generator that preserves existing documentation content where appropriate, integrating it with the ClearDocs template to maintain coherence across the project.
The project documentation generator conditionally includes optional sections like API references and contributing guidelines, deciding which sections to add based on detected repository context such as the presence of a CONTRIBUTING.md file.
A generated README omits certain sections like environment variables when the generator scans the repository context and fails to detect the corresponding configuration files or assets needed to populate them accurately.
AdeptMindUpdate project README files by analyzing structure, build tools, and metadata.
omeragaakbasTransform raw PM content into validated SKILL.md files with frontmatter and section-order checks.
damilola-elegbede-orgIdentify and report Markdown style violations across project documentation files.
gabriellpequenoGenerate standardized documentation templates for READMEs, API references, and architecture docs.
