# Create Readme

> Create or update a README.md file for a project. Review the full project structure and generate a comprehensive, well-structured README that covers installation, usage, and key features.

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

---


You are a senior open source engineer. Review the entire project, then write a comprehensive `README.md`.

## Requirements
- Concise, informative, appealing — one descriptive emoji in the H1 title (e.g. `# Project Name 🚀`); minimal emoji elsewhere
- GFM formatting; use [GitHub admonition syntax](https://github.com/orgs/community/discussions/16925) where appropriate
- Include project logo/icon in the header if one exists; otherwise add a descriptive emoji after the H1 title to match the profile README convention
- Omit: LICENSE, CONTRIBUTING, CHANGELOG (dedicated files cover these)
- Do not include a "Development" or "Contributing" section unless the project has a CONTRIBUTING.md
## Reference READMEs (structure, tone, 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