{
  "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": {
    "downloadMode": "redirect",
    "downloadUrl": "/downloads/readme-generator",
    "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=readme-generator",
    "sourcePlatform": "tencent",
    "targetPlatform": "OpenClaw",
    "installMethod": "Manual import",
    "extraction": "Extract archive",
    "prerequisites": [
      "OpenClaw"
    ],
    "packageFormat": "ZIP package",
    "includedAssets": [
      "SKILL.md"
    ],
    "primaryDoc": "SKILL.md",
    "quickSetup": [
      "Download the package from Yavira.",
      "Extract the archive and review SKILL.md first.",
      "Import or place the package into your OpenClaw setup."
    ],
    "agentAssist": {
      "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
      "steps": [
        "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."
      ],
      "prompts": [
        {
          "label": "New install",
          "body": "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."
        },
        {
          "label": "Upgrade existing",
          "body": "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."
        }
      ]
    },
    "sourceHealth": {
      "source": "tencent",
      "status": "healthy",
      "reason": "direct_download_ok",
      "recommendedAction": "download",
      "checkedAt": "2026-04-23T16:43:11.935Z",
      "expiresAt": "2026-04-30T16:43:11.935Z",
      "httpStatus": 200,
      "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=4claw-imageboard",
      "contentType": "application/zip",
      "probeMethod": "head",
      "details": {
        "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=4claw-imageboard",
        "contentDisposition": "attachment; filename=\"4claw-imageboard-1.0.1.zip\"",
        "redirectLocation": null,
        "bodySnippet": null
      },
      "scope": "source",
      "summary": "Source download looks usable.",
      "detail": "Yavira can redirect you to the upstream package for this source.",
      "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."
      ]
    },
    "downloadPageUrl": "https://openagent3.xyz/downloads/readme-generator",
    "agentPageUrl": "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"
  },
  "agentAssist": {
    "summary": "Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.",
    "steps": [
      "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."
    ],
    "prompts": [
      {
        "label": "New install",
        "body": "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."
      },
      {
        "label": "Upgrade existing",
        "body": "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."
      }
    ]
  },
  "documentation": {
    "source": "clawhub",
    "primaryDoc": "SKILL.md",
    "sections": [
      {
        "title": "readme-generator — Production-Quality README Generator",
        "body": "Analyze a project's structure and generate a comprehensive, framework-aware README.md."
      },
      {
        "title": "1. Analyze Project Structure",
        "body": "Read these files (if they exist):\n\npackage.json / pyproject.toml / Cargo.toml / go.mod — name, description, version, deps\ntsconfig.json — TypeScript config\ndocker-compose.yml / Dockerfile — containerization\n.github/workflows/ — CI/CD\nLICENSE / LICENSE.md — license type\nEntry points: src/index.*, src/main.*, app.*, main.*, index.*\ntests/ / test/ / __tests__/ / spec/ — test setup\n\n# Get file tree (depth 3, ignore common dirs)\nfind . -maxdepth 3 -not -path '*/node_modules/*' -not -path '*/.git/*' -not -path '*/dist/*' -not -path '*/__pycache__/*' | head -100\n# Windows alternative:\nGet-ChildItem -Recurse -Depth 3 -Exclude node_modules,.git,dist,__pycache__ | Select-Object -First 100 FullName"
      },
      {
        "title": "2. Detect Framework & Ecosystem",
        "body": "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"
      },
      {
        "title": "3. Determine Install & Run Commands",
        "body": "Based on detected ecosystem:\n\nNode.js: Check for lockfiles to determine package manager.\n\npnpm-lock.yaml → pnpm install / pnpm dev\nyarn.lock → yarn / yarn dev\npackage-lock.json → npm install / npm run dev\nRead scripts in package.json for available commands.\n\nPython: Check for pip, poetry, pipenv.\n\npoetry.lock → poetry install / poetry run ...\nPipfile → pipenv install / pipenv run ...\nrequirements.txt → pip install -r requirements.txt\n\nRust: cargo build / cargo run\n\nGo: go build / go run ."
      },
      {
        "title": "4. Generate Badges",
        "body": "Build badge URLs from detected tools:\n\n![License](https://img.shields.io/badge/license-MIT-blue.svg)\n![Node](https://img.shields.io/badge/node-%3E%3D18-brightgreen)\n![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue)\n\nOnly include badges for things actually detected. Common badges: license, language/runtime version, CI status, test coverage."
      },
      {
        "title": "5. Assemble README",
        "body": "Use this structure:\n\n# Project Name\n\nBrief description from package.json/pyproject.toml or inferred from code.\n\n## Table of Contents\n- [Features](#features)\n- [Prerequisites](#prerequisites)\n- [Installation](#installation)\n- [Usage](#usage)\n- [API Reference](#api-reference)  ← only if applicable\n- [Configuration](#configuration)  ← only if env vars detected\n- [Testing](#testing)\n- [Deployment](#deployment)  ← only if Docker/CI detected\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n- Bullet list of key capabilities (infer from code structure, routes, exports)\n\n## Prerequisites\n- Runtime version (node >= 18, python >= 3.10, etc.)\n- Required system tools (Docker, database, etc.)\n\n## Installation\n[Package-manager-specific install commands from Step 3]\n\n## Usage\n[Dev/start commands, example API calls if it's a server]\n\n## API Reference\n[Only for libraries/APIs — list exported functions or endpoints]\n\n## Configuration\n[Environment variables — reference env-setup skill if complex]\n\n## Testing\n[Test runner command: npm test, pytest, cargo test, etc.]\n\n## Contributing\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feat/amazing-feature`)\n3. Commit your changes (`git commit -m 'feat: add amazing feature'`)\n4. Push to the branch (`git push origin feat/amazing-feature`)\n5. Open a Pull Request\n\n## License\n[Detected license or \"See LICENSE file\"]"
      },
      {
        "title": "6. Tailor to Framework",
        "body": "Next.js: Add sections for pages/app router, API routes, environment variables\nExpress/FastAPI: Document route structure, middleware, API endpoints\nReact/Vue: Document component structure, state management, build output\nCLI tools: Document command-line arguments and flags\nLibraries: Focus on API docs, installation, and usage examples"
      },
      {
        "title": "7. Output",
        "body": "Write to README.md in the project root. If one exists, ask user before overwriting — offer to write to README.generated.md instead."
      },
      {
        "title": "Edge Cases",
        "body": "Monorepo: Generate a root README linking to sub-packages, plus per-package READMEs\nEmpty project: Generate a minimal skeleton README with TODOs\nNo package manifest: Infer from file extensions and directory structure\nExisting README: Ask before overwriting; diff and suggest additions"
      },
      {
        "title": "Error Handling",
        "body": "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\n\nBuilt by Clawb (SOVEREIGN) — more skills at [coming soon]"
      }
    ],
    "body": "readme-generator — Production-Quality README Generator\n\nAnalyze a project's structure and generate a comprehensive, framework-aware README.md.\n\nSteps\n1. Analyze Project Structure\n\nRead these files (if they exist):\n\npackage.json / pyproject.toml / Cargo.toml / go.mod — name, description, version, deps\ntsconfig.json — TypeScript config\ndocker-compose.yml / Dockerfile — containerization\n.github/workflows/ — CI/CD\nLICENSE / LICENSE.md — license type\nEntry points: src/index.*, src/main.*, app.*, main.*, index.*\ntests/ / test/ / __tests__/ / spec/ — test setup\n# Get file tree (depth 3, ignore common dirs)\nfind . -maxdepth 3 -not -path '*/node_modules/*' -not -path '*/.git/*' -not -path '*/dist/*' -not -path '*/__pycache__/*' | head -100\n# Windows alternative:\nGet-ChildItem -Recurse -Depth 3 -Exclude node_modules,.git,dist,__pycache__ | Select-Object -First 100 FullName\n\n2. Detect Framework & Ecosystem\nSignal\tFramework\nnext.config.* or \"next\" in deps\tNext.js\n\"express\" in deps\tExpress.js\n\"fastapi\" in deps\tFastAPI\n\"django\" in deps\tDjango\n\"flask\" in deps\tFlask\n\"react\" in deps (no next)\tReact (CRA/Vite)\n\"vue\" in deps\tVue.js\n\"svelte\" in deps\tSvelteKit\nCargo.toml with [[bin]]\tRust CLI\nCargo.toml with actix-web/axum\tRust Web\ngo.mod\tGo\n3. Determine Install & Run Commands\n\nBased on detected ecosystem:\n\nNode.js: Check for lockfiles to determine package manager.\n\npnpm-lock.yaml → pnpm install / pnpm dev\nyarn.lock → yarn / yarn dev\npackage-lock.json → npm install / npm run dev\nRead scripts in package.json for available commands.\n\nPython: Check for pip, poetry, pipenv.\n\npoetry.lock → poetry install / poetry run ...\nPipfile → pipenv install / pipenv run ...\nrequirements.txt → pip install -r requirements.txt\n\nRust: cargo build / cargo run\n\nGo: go build / go run .\n\n4. Generate Badges\n\nBuild badge URLs from detected tools:\n\n![License](https://img.shields.io/badge/license-MIT-blue.svg)\n![Node](https://img.shields.io/badge/node-%3E%3D18-brightgreen)\n![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue)\n\n\nOnly include badges for things actually detected. Common badges: license, language/runtime version, CI status, test coverage.\n\n5. Assemble README\n\nUse this structure:\n\n# Project Name\n\nBrief description from package.json/pyproject.toml or inferred from code.\n\n## Table of Contents\n- [Features](#features)\n- [Prerequisites](#prerequisites)\n- [Installation](#installation)\n- [Usage](#usage)\n- [API Reference](#api-reference)  ← only if applicable\n- [Configuration](#configuration)  ← only if env vars detected\n- [Testing](#testing)\n- [Deployment](#deployment)  ← only if Docker/CI detected\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n- Bullet list of key capabilities (infer from code structure, routes, exports)\n\n## Prerequisites\n- Runtime version (node >= 18, python >= 3.10, etc.)\n- Required system tools (Docker, database, etc.)\n\n## Installation\n[Package-manager-specific install commands from Step 3]\n\n## Usage\n[Dev/start commands, example API calls if it's a server]\n\n## API Reference\n[Only for libraries/APIs — list exported functions or endpoints]\n\n## Configuration\n[Environment variables — reference env-setup skill if complex]\n\n## Testing\n[Test runner command: npm test, pytest, cargo test, etc.]\n\n## Contributing\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feat/amazing-feature`)\n3. Commit your changes (`git commit -m 'feat: add amazing feature'`)\n4. Push to the branch (`git push origin feat/amazing-feature`)\n5. Open a Pull Request\n\n## License\n[Detected license or \"See LICENSE file\"]\n\n6. Tailor to Framework\nNext.js: Add sections for pages/app router, API routes, environment variables\nExpress/FastAPI: Document route structure, middleware, API endpoints\nReact/Vue: Document component structure, state management, build output\nCLI tools: Document command-line arguments and flags\nLibraries: Focus on API docs, installation, and usage examples\n7. Output\n\nWrite to README.md in the project root. If one exists, ask user before overwriting — offer to write to README.generated.md instead.\n\nEdge Cases\nMonorepo: Generate a root README linking to sub-packages, plus per-package READMEs\nEmpty project: Generate a minimal skeleton README with TODOs\nNo package manifest: Infer from file extensions and directory structure\nExisting README: Ask before overwriting; diff and suggest additions\nError Handling\nError\tResolution\nCan't detect framework\tGenerate a generic README; ask user to specify\nNo description available\tUse directory name; prompt user to add one\nNo license file\tNote it's missing; suggest adding one\nVery large project\tLimit tree scan depth; focus on src/ and root config\n\nBuilt by Clawb (SOVEREIGN) — more skills at [coming soon]"
  },
  "trust": {
    "sourceLabel": "tencent",
    "provenanceUrl": "https://clawhub.ai/Fratua/readme-generator",
    "publisherUrl": "https://clawhub.ai/Fratua/readme-generator",
    "owner": "Fratua",
    "version": "1.0.0",
    "license": null,
    "verificationStatus": "Indexed source record"
  },
  "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"
  }
}