How do I install the Create Readme skill?

Run npx skillmds@latest add mgiovannibh/create-readme in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

What does the Create Readme skill do?

Create a README.md file for the project. Use when you need to document a source code project. It is listed under Coding & Dev Tools on SkillMD.

Is Create Readme safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: PASS, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Create Readme?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Create Readme free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Create Readme?

MgiovanniBH (@mgiovannibh) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Create Readme by mgiovannibh — Agent Skill

Name: Create Readme
Author: MgiovanniBH

File contents

Role

You're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.

Task

Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
Take inspiration from these readme files for the structure, tone and content:
Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
If you find a logo or icon for the project, use it in the readme's header.
Tone and Style: Technical, clear, and professional. Use the OpenAPI standard where appropriate.
Centered Header & Badges: Include a centered header block containing the title, a brief description, quick links, and a single-line horizontal row of technology badges/icons (e.g. Java 17, Spring Boot, Spring Cloud, Gradle, Kafka) to optimize vertical space.
Heading Icons: Keep original section headings and their respective emojis/icons (e.g., 🏛️, 🗄️, ⚙️, 🚀) to maintain the project's visual identity.
Batch Idempotency: If the project is a batch job, explicitly define the idempotency criterion used inside the "Funcionalidades" section (e.g., query constraints, database lookup checks, unique keys) to prevent duplicate processing.

---name: create-readmedescription: Create a README.md file for the project. Use when you need to document a source code project.---## RoleYou're a senior expert software engineer with extensive experience in open source projects. You always make sure the README files you write are appealing, informative, and easy to read.## Task1. Take a deep breath, and review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.2. Take inspiration from these readme files for the structure, tone and content: - https://raw.githubusercontent.com/Azure-Samples/serverless-chat-langchainjs/refs/heads/main/README.md - https://raw.githubusercontent.com/Azure-Samples/serverless-recipes-javascript/refs/heads/main/README.md - https://raw.githubusercontent.com/sinedied/run-on-output/refs/heads/main/README.md - https://raw.githubusercontent.com/sinedied/smoke/refs/heads/main/README.md3. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.4. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.5. If you find a logo or icon for the project, use it in the readme's header.6. Tone and Style: Technical, clear, and professional. Use the OpenAPI standard where appropriate.7. Centered Header & Badges: Include a centered header block containing the title, a brief description, quick links, and a single-line horizontal row of technology badges/icons (e.g. Java 17, Spring Boot, Spring Cloud, Gradle, Kafka) to optimize vertical space.8. Heading Icons: Keep original section headings and their respective emojis/icons (e.g., `🏛️`, `🗄️`, `⚙️`, `🚀`) to maintain the project's visual identity.9. Batch Idempotency: If the project is a batch job, explicitly define the idempotency criterion used inside the "Funcionalidades" section (e.g., query constraints, database lookup checks, unique keys) to prevent duplicate processing.

Frequently asked questions

Create Readme