@github/create-readme
Create a README.md file for the project
No skills found in this collection.
SKILL.md
| name | create-readme |
| description | Create a README.md file for the project |
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:
- 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
- Do not overuse emojis, and keep the readme concise and to the point.
- 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.
Loading...
Select a file to preview
Analyzing security...
Checking scan reports and verification data.
Bill of Materials
Everything this skill can do — files, network, commands, and more.
No demos yet. To add one, ask your AI agent: "Submit a demo for @github/create-readme" — or upload via the API.
To add a demo, ask your AI agent: "Submit a demo for @github/create-readme"
No eval data yet. Eval results are published via the SkillSafe API.