# Send README Generator to your agent Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually. ## Fast path - Download the package from Yavira. - Extract it into a folder your agent can access. - Paste one of the prompts below and point your agent at the extracted folder. ## Suggested prompts ### New install ```text I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete. ``` ### Upgrade existing ```text I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run. ``` ## Machine-readable fields ```json { "schemaVersion": "1.0", "item": { "slug": "readme-generator", "name": "README Generator", "source": "tencent", "type": "skill", "category": "内容创作", "sourceUrl": "https://clawhub.ai/Fratua/readme-generator", "canonicalUrl": "https://clawhub.ai/Fratua/readme-generator", "targetPlatform": "OpenClaw" }, "install": { "downloadUrl": "/downloads/readme-generator", "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=readme-generator", "sourcePlatform": "tencent", "targetPlatform": "OpenClaw", "packageFormat": "ZIP package", "primaryDoc": "SKILL.md", "includedAssets": [ "SKILL.md" ], "downloadMode": "redirect", "sourceHealth": { "source": "tencent", "slug": "readme-generator", "status": "healthy", "reason": "direct_download_ok", "recommendedAction": "download", "checkedAt": "2026-04-30T12:19:24.842Z", "expiresAt": "2026-05-07T12:19:24.842Z", "httpStatus": 200, "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=readme-generator", "contentType": "application/zip", "probeMethod": "head", "details": { "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=readme-generator", "contentDisposition": "attachment; filename=\"readme-generator-1.0.0.zip\"", "redirectLocation": null, "bodySnippet": null, "slug": "readme-generator" }, "scope": "item", "summary": "Item download looks usable.", "detail": "Yavira can redirect you to the upstream package for this item.", "primaryActionLabel": "Download for OpenClaw", "primaryActionHref": "/downloads/readme-generator" }, "validation": { "installChecklist": [ "Use the Yavira download entry.", "Review SKILL.md after the package is downloaded.", "Confirm the extracted package contains the expected setup assets." ], "postInstallChecks": [ "Confirm the extracted package includes the expected docs or setup files.", "Validate the skill or prompts are available in your target agent workspace.", "Capture any manual follow-up steps the agent could not complete." ] } }, "links": { "detailUrl": "https://openagent3.xyz/skills/readme-generator", "downloadUrl": "https://openagent3.xyz/downloads/readme-generator", "agentUrl": "https://openagent3.xyz/skills/readme-generator/agent", "manifestUrl": "https://openagent3.xyz/skills/readme-generator/agent.json", "briefUrl": "https://openagent3.xyz/skills/readme-generator/agent.md" } } ``` ## Documentation ### readme-generator — Production-Quality README Generator Analyze a project's structure and generate a comprehensive, framework-aware README.md. ### 1. Analyze Project Structure Read these files (if they exist): package.json / pyproject.toml / Cargo.toml / go.mod — name, description, version, deps tsconfig.json — TypeScript config docker-compose.yml / Dockerfile — containerization .github/workflows/ — CI/CD LICENSE / LICENSE.md — license type Entry points: src/index.*, src/main.*, app.*, main.*, index.* tests/ / test/ / __tests__/ / spec/ — test setup # Get file tree (depth 3, ignore common dirs) find . -maxdepth 3 -not -path '*/node_modules/*' -not -path '*/.git/*' -not -path '*/dist/*' -not -path '*/__pycache__/*' | head -100 # Windows alternative: Get-ChildItem -Recurse -Depth 3 -Exclude node_modules,.git,dist,__pycache__ | Select-Object -First 100 FullName ### 2. Detect Framework & Ecosystem SignalFrameworknext.config.* or "next" in depsNext.js"express" in depsExpress.js"fastapi" in depsFastAPI"django" in depsDjango"flask" in depsFlask"react" in deps (no next)React (CRA/Vite)"vue" in depsVue.js"svelte" in depsSvelteKitCargo.toml with [[bin]]Rust CLICargo.toml with actix-web/axumRust Webgo.modGo ### 3. Determine Install & Run Commands Based on detected ecosystem: Node.js: Check for lockfiles to determine package manager. pnpm-lock.yaml → pnpm install / pnpm dev yarn.lock → yarn / yarn dev package-lock.json → npm install / npm run dev Read scripts in package.json for available commands. Python: Check for pip, poetry, pipenv. poetry.lock → poetry install / poetry run ... Pipfile → pipenv install / pipenv run ... requirements.txt → pip install -r requirements.txt Rust: cargo build / cargo run Go: go build / go run . ### 4. Generate Badges Build badge URLs from detected tools: ![License](https://img.shields.io/badge/license-MIT-blue.svg) ![Node](https://img.shields.io/badge/node-%3E%3D18-brightgreen) ![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue) Only include badges for things actually detected. Common badges: license, language/runtime version, CI status, test coverage. ### 5. Assemble README Use this structure: # Project Name Brief description from package.json/pyproject.toml or inferred from code. ## Table of Contents - [Features](#features) - [Prerequisites](#prerequisites) - [Installation](#installation) - [Usage](#usage) - [API Reference](#api-reference) ← only if applicable - [Configuration](#configuration) ← only if env vars detected - [Testing](#testing) - [Deployment](#deployment) ← only if Docker/CI detected - [Contributing](#contributing) - [License](#license) ## Features - Bullet list of key capabilities (infer from code structure, routes, exports) ## Prerequisites - Runtime version (node >= 18, python >= 3.10, etc.) - Required system tools (Docker, database, etc.) ## Installation [Package-manager-specific install commands from Step 3] ## Usage [Dev/start commands, example API calls if it's a server] ## API Reference [Only for libraries/APIs — list exported functions or endpoints] ## Configuration [Environment variables — reference env-setup skill if complex] ## Testing [Test runner command: npm test, pytest, cargo test, etc.] ## Contributing 1. Fork the repository 2. Create your feature branch (\`git checkout -b feat/amazing-feature\`) 3. Commit your changes (\`git commit -m 'feat: add amazing feature'\`) 4. Push to the branch (\`git push origin feat/amazing-feature\`) 5. Open a Pull Request ## License [Detected license or "See LICENSE file"] ### 6. Tailor to Framework Next.js: Add sections for pages/app router, API routes, environment variables Express/FastAPI: Document route structure, middleware, API endpoints React/Vue: Document component structure, state management, build output CLI tools: Document command-line arguments and flags Libraries: Focus on API docs, installation, and usage examples ### 7. Output Write to README.md in the project root. If one exists, ask user before overwriting — offer to write to README.generated.md instead. ### Edge Cases Monorepo: Generate a root README linking to sub-packages, plus per-package READMEs Empty project: Generate a minimal skeleton README with TODOs No package manifest: Infer from file extensions and directory structure Existing README: Ask before overwriting; diff and suggest additions ### Error Handling ErrorResolutionCan't detect frameworkGenerate a generic README; ask user to specifyNo description availableUse directory name; prompt user to add oneNo license fileNote it's missing; suggest adding oneVery large projectLimit tree scan depth; focus on src/ and root config Built by Clawb (SOVEREIGN) — more skills at [coming soon] ## Trust - Source: tencent - Verification: Indexed source record - Publisher: Fratua - Version: 1.0.0 ## Source health - Status: healthy - Item download looks usable. - Yavira can redirect you to the upstream package for this item. - Health scope: item - Reason: direct_download_ok - Checked at: 2026-04-30T12:19:24.842Z - Expires at: 2026-05-07T12:19:24.842Z - Recommended action: Download for OpenClaw ## Links - [Detail page](https://openagent3.xyz/skills/readme-generator) - [Send to Agent page](https://openagent3.xyz/skills/readme-generator/agent) - [JSON manifest](https://openagent3.xyz/skills/readme-generator/agent.json) - [Markdown brief](https://openagent3.xyz/skills/readme-generator/agent.md) - [Download page](https://openagent3.xyz/downloads/readme-generator)