Name: create-readme
Author: ronload

Imported from ronload/dotfiles (agents/skills/create-readme/SKILL.md). Install upstream with npx skills add ronload/dotfiles --skill create-readme. Copyright stays with the author (MIT).

The result must be appealing, informative, and easy to read.

Task

Review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.
Follow references/readme-structure.md for section order, tone, and length.
Do not use 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.
Render callout-style blockquotes as GitHub alerts: open with [!NOTE], [!TIP], [!IMPORTANT], [!WARNING], or [!CAUTION] on the first line, every line prefixed with >, and pick the type by intent. Reserve a plain blockquote only for a verbatim quotation; never label a quote as an alert. Only these five markers are valid on GitHub; others fall back to plain blockquotes.

# after Install: the listing is in your workspace's routing pool - a plan picks it for its slot curl -s -X POST https://api.opensmartroute.ai/api/v1/route -H 'Authorization: Bearer $OSR_API_KEY' -H 'Content-Type: application/json' -d '{"text": "...", "plan": true}'

{ "ocm": "1", "id": "ronload-dotfiles-create-readme", "kind": "skill", "name": "create-readme", "description": "Write or rewrite a project's README.md from the repository's actual structure and conventions. Use when the user asks to create, generate, rewrite or improve a README, or asks for a project overview to live in README.md. Do not use for other documentation files, for editing a single section the user quotes, or for answering questions about a project in chat.", "publisher": "ronload", "version": "1.0.0", "capabilities": { "domains": [ "general" ], "tags": [ "skill-md", "github" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "Write or rewrite a project's README.md from the repository's actual structure and conventions. Use when the user asks to create, generate, rewrite or improve a README, or asks for a project overview to live in README.md. Do not use for other documentation files, for editing a single section the user quotes, or for answering questions about a project in chat." ], "primary": false, "metadata": { "source": { "provider": "github", "repository": "https://github.com/ronload/dotfiles", "path": "agents/skills/create-readme/SKILL.md", "ref": "2454417512bc0a3bc08487435013e9a358577507", "url": "https://github.com/ronload/dotfiles/blob/2454417512bc0a3bc08487435013e9a358577507/agents/skills/create-readme/SKILL.md", "key": "ronload/dotfiles/agents/skills/create-readme/SKILL.md" }, "allowed_tools": [ "Read", "Glob", "Grep" ], "license": "MIT" }, "instructions": "The result must be appealing, informative, and easy to read.\n\n## Task\n\n1. Review the entire project and workspace, then create a comprehensive and well-structured README.md file for the project.\n2. Follow `references/readme-structure.md` for section order, tone, and length.\n3. Do not use emojis, and keep the readme concise and to the point.\n4. Do not include sections like \"LICENSE\", \"CONTRIBUTING\", \"CHANGELOG\", etc. There are dedicated files for those sections.\n5. Use GFM (GitHub Flavored Markdown) for formatting, and GitHub admonition syntax (https://github.com/orgs/community/discussions/1692", "cost": { "context_tokens": 270 } }

create-readme

About

Task

Use it

Manifest

Reviews