# Create Readme

> Create a README.md file for the project. Use when you need to document a source code project.

- Skill: `mgiovannibh/create-readme` (Agent Skill)
- Install (CLI): `npx skillmds@latest add mgiovannibh/create-readme`
- Raw SKILL.md: https://api.skillmd.com/api/skills/mgiovannibh/create-readme/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: MgiovanniBH (https://skillmd.com/u/mgiovannibh)
- Updated: 2026-09-22
- Page: https://skillmd.com/skills/mgiovannibh/create-readme

---


## 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

1. 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.md
3. 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.