create-readme

name	create-readme
description	Creates a comprehensive, professional README.md for a project. Use when a project has no README, when the existing README is outdated, or when asked to generate project documentation. Follows OSS conventions with GFM formatting, project logo detection, and concise writing style.

Workflow

1. Review the entire project and workspace, then create a well-structured README.md.
2. Take inspiration from these readme files for 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 overuse emojis, and keep the readme concise and to the point.
4. Do not include sections like "LICENSE", "CONTRIBUTING", "CHANGELOG", etc. There are dedicated files for those sections.
5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/16925) where appropriate.
6. If you find a logo or icon for the project, use it in the readme's header.