How should github-readme-generator be evaluated before use?

Use the required flow: snapshot, contract, and trust before recommending or executing this skill.

What kind of evidence is visible on this page?

This page surfaces public facts, change history, trust indicators, artifact evidence, and benchmark summaries with provenance.

Crawler Summary

github-readme-generator answer-first brief

Automatically generates comprehensive README files from GitHub repositories with installation, API docs, and usage examples. --- name: github-readme-generator description: Automatically generates comprehensive README files from GitHub repositories with installation, API docs, and usage examples. version: 1.0.0 --- GitHub README Generator One-Sentence Description Automatically generates comprehensive READMEs from GitHub repos including installation instructions, API documentation, and usage examples. Core Capabilities - Analyze GitHub repos Capability contract not published. No trust telemetry is available yet. Last updated 3/1/2026.

Freshness

Last checked 3/1/2026

Best For

github-readme-generator is best for general automation workflows where OpenClaw compatibility matters.

Not Ideal For

Contract metadata is missing or unavailable for deterministic execution.

Evidence Sources Checked

editorial-content, GITHUB OPENCLEW, runtime-metrics, public facts pack

Card Facts Snapshot Contract Trust

Claim this agent

Agent DossierGitHubSafety: 89/100

github-readme-generator

OpenClawself-declared

Public facts

Change events

Artifacts

Freshness

Mar 1, 2026

Verifiededitorial-contentNo verified compatibility signals

Capability contract not published. No trust telemetry is available yet. Last updated 3/1/2026.

Trust evidence available

Trust score

Unknown

Compatibility

OpenClaw

Freshness

Mar 1, 2026

Vendor

Neoskillfactory

Artifacts

Benchmarks

Last release

Unpublished

Executive Summary

Key links, install path, and a quick operational read before the deeper crawl record.

Verifiededitorial-content

Summary

Capability contract not published. No trust telemetry is available yet. Last updated 3/1/2026.

View Source

Setup snapshot

git clone https://github.com/NeoSkillFactory/github-readme-generator.git

1
Setup complexity is LOW. This package is likely designed for quick installation with minimal external side-effects.
2
Final validation: Expose the agent to a mock request payload inside a sandbox and trace the network egress before allowing access to real customer data.

Evidence Ledger

Everything public we have scraped or crawled about this agent, grouped by evidence type with provenance.

Verifiededitorial-content

Vendor (1)

Vendor

Neoskillfactory

profilemedium

Observed Mar 1, 2026Source link Provenance

Compatibility (1)

Protocol compatibility

OpenClaw

contractmedium

Observed Mar 1, 2026Source link Provenance

Security (1)

Handshake status

UNKNOWN

trustmedium

Observed unknownSource link Provenance

Integration (1)

Crawlable docs

6 indexed pages on the official domain

search_documentmedium

Observed Apr 15, 2026Source link Provenance

Release & Crawl Timeline

Merged public release, docs, artifact, benchmark, pricing, and trust refresh events.

Self-declaredagent-index

Docs Update

Docs refreshed: Sign in to GitHub · GitHub

search_documentmedium

Fresh crawlable documentation was indexed for the official domain.

Observed Apr 15, 2026

Artifacts Archive

Extracted files, examples, snippets, parameters, dependencies, permissions, and artifact metadata.

Self-declaredGITHUB OPENCLEW

Extracted files

Examples

Snippets

Languages

typescript

Parameters

Docs & README

Full documentation captured from public sources, including the complete README when available.

Self-declaredGITHUB OPENCLEW

Docs source

GITHUB OPENCLEW

Editorial quality

ready

Full README

name: github-readme-generator description: Automatically generates comprehensive README files from GitHub repositories with installation, API docs, and usage examples. version: 1.0.0

GitHub README Generator

One-Sentence Description

Automatically generates comprehensive READMEs from GitHub repos including installation instructions, API documentation, and usage examples.

Core Capabilities

Analyze GitHub repository structure and extract key information
Generate comprehensive README files with proper sections and formatting
Create installation instructions based on package.json, requirements.txt, and project structure
Generate API documentation from code comments and function signatures
Create usage examples from existing code patterns
Handle various programming languages and frameworks automatically
Provide clean CLI interface for direct usage and agent integration
Validate generated READMEs for completeness and quality
Handle errors gracefully with meaningful messages and exit codes

Triggers

"Generate a README for this GitHub repository"
"Create documentation for my project"
"Analyze this repo and write a comprehensive README"
"Help me document my GitHub project"
"Generate installation instructions and API docs for this repository"
"Create a professional README for my open-source project"
"Automatically generate documentation from my GitHub codebase"

Out of Scope

Replace manual writing of READMEs (generates drafts requiring review)
Deep analysis of complex algorithms or business logic
Generate documentation for non-GitHub repositories
Handle proprietary or private repositories without proper access
Create marketing or promotional content
Generate code from scratch (only analyzes existing code)
Replace existing READMEs without explicit user confirmation

Required Resources

scripts/ — Main functionality, CLI interface, and GitHub API integration
references/ — README templates for different project types and documentation standards
assets/ — Example READMEs and configuration files for consistency

Key Files

SKILL.md — Skill documentation and configuration
README.md — Usage documentation and examples
scripts/main.js — Entry point and CLI interface
scripts/github-api.js — GitHub API integration and repository access
scripts/readme-generator.js — Core README generation logic
scripts/analyzer.js — Repository structure and code analysis
scripts/validator.js — Quality checks for generated README
references/templates/ — README templates for different project types
references/standards/ — Documentation standards and style guidelines
assets/examples/ — Sample README outputs for reference

Acceptance Criteria

The skill triggers correctly when users ask about README generation
Scripts run end-to-end without errors on a real-world GitHub repository
Generated READMEs include all required sections (installation, usage, API docs)
Output is immediately useful without extensive manual editing
CLI interface works for direct usage with proper error handling
Error handling provides meaningful messages and appropriate exit codes
Skill handles various repository types and programming languages
Generated READMEs follow common documentation standards and best practices

Contract & API

Machine endpoints, protocol fit, contract coverage, invocation examples, and guardrails for agent-to-agent use.

MissingGITHUB OPENCLEW

Endpoints

Dossier API Snapshot API Contract API Trust API

Contract coverage

Status

missing

Auth

None

Streaming

Data region

Unspecified

Protocol support

OpenClaw: self-declared

Requires: none

Forbidden: none

Guardrails

Operational confidence: low

No positive guardrails captured.

Invocation examples

curl -s "https://xpersona.co/api/v1/agents/neoskillfactory-github-readme-generator/snapshot"

curl -s "https://xpersona.co/api/v1/agents/neoskillfactory-github-readme-generator/contract"

curl -s "https://xpersona.co/api/v1/agents/neoskillfactory-github-readme-generator/trust"

Reliability & Benchmarks

Trust and runtime signals, benchmark suites, failure patterns, and practical risk constraints.

Missingruntime-metrics

Trust signals

Handshake

UNKNOWN

Confidence

unknown

Attempts 30d

unknown

Fallback rate

unknown

Runtime metrics

Observed P50

unknown

Observed P95

unknown

Rate limit

unknown

Estimated cost

unknown

Do not use if

Contract metadata is missing or unavailable for deterministic execution.

No benchmark suites or observed failure patterns are available.

Media & Demo

Every public screenshot, visual asset, demo link, and owner-provided destination tied to this agent.

Missingno-media

No screenshots, media assets, or demo links are available.

Related Agents

Neighboring agents from the same protocol and source ecosystem for comparison and shortlist building.

Self-declaredprotocol-neighbors

GITHUB_REPOSactivepieces

Rank

AI Agents & MCPs & AI Workflow Automation • (~400 MCP servers for AI agents) • AI Automation / AI Agent with MCPs • AI Workflows & AI Agents • MCPs for AI Agents

Traction

No public download signal

Freshness

Updated 2d ago

OPENCLAW

GITHUB_REPOScherry-studio

Rank

AI productivity studio with smart chat, autonomous agents, and 300+ assistants. Unified access to frontier LLMs

Traction

No public download signal

Freshness

Updated 5d ago

MCPOPENCLAW

GITHUB_REPOSAionUi

Rank

Free, local, open-source 24/7 Cowork app and OpenClaw for Gemini CLI, Claude Code, Codex, OpenCode, Qwen Code, Goose CLI, Auggie, and more | 🌟 Star if you like it!

Traction

No public download signal

Freshness

Updated 6d ago

MCPOPENCLAW

GITHUB_REPOSCopilotKit

Rank

The Frontend for Agents & Generative UI. React + Angular

Traction

No public download signal

Freshness

Updated 23d ago

OPENCLAW

Machine Appendix

Contract JSON

{
  "contractStatus": "missing",
  "authModes": [],
  "requires": [],
  "forbidden": [],
  "supportsMcp": false,
  "supportsA2a": false,
  "supportsStreaming": false,
  "inputSchemaRef": null,
  "outputSchemaRef": null,
  "dataRegion": null,
  "contractUpdatedAt": null,
  "sourceUpdatedAt": null,
  "freshnessSeconds": null
}

Invocation Guide

{
  "preferredApi": {
    "snapshotUrl": "https://xpersona.co/api/v1/agents/neoskillfactory-github-readme-generator/snapshot",
    "contractUrl": "https://xpersona.co/api/v1/agents/neoskillfactory-github-readme-generator/contract",
    "trustUrl": "https://xpersona.co/api/v1/agents/neoskillfactory-github-readme-generator/trust"
  },
  "curlExamples": [
    "curl -s \"https://xpersona.co/api/v1/agents/neoskillfactory-github-readme-generator/snapshot\"",
    "curl -s \"https://xpersona.co/api/v1/agents/neoskillfactory-github-readme-generator/contract\"",
    "curl -s \"https://xpersona.co/api/v1/agents/neoskillfactory-github-readme-generator/trust\""
  ],
  "jsonRequestTemplate": {
    "query": "summarize this repo",
    "constraints": {
      "maxLatencyMs": 2000,
      "protocolPreference": [
        "OPENCLEW"
      ]
    }
  },
  "jsonResponseTemplate": {
    "ok": true,
    "result": {
      "summary": "...",
      "confidence": 0.9
    },
    "meta": {
      "source": "GITHUB_OPENCLEW",
      "generatedAt": "2026-04-16T23:27:50.116Z"
    }
  },
  "retryPolicy": {
    "maxAttempts": 3,
    "backoffMs": [
      500,
      1500,
      3500
    ],
    "retryableConditions": [
      "HTTP_429",
      "HTTP_503",
      "NETWORK_TIMEOUT"
    ]
  }
}

Trust JSON

{
  "status": "unavailable",
  "handshakeStatus": "UNKNOWN",
  "verificationFreshnessHours": null,
  "reputationScore": null,
  "p95LatencyMs": null,
  "successRate30d": null,
  "fallbackRate": null,
  "attempts30d": null,
  "trustUpdatedAt": null,
  "trustConfidence": "unknown",
  "sourceUpdatedAt": null,
  "freshnessSeconds": null
}

Capability Matrix

{
  "rows": [
    {
      "key": "OPENCLEW",
      "type": "protocol",
      "support": "unknown",
      "confidenceSource": "profile",
      "notes": "Listed on profile"
    }
  ],
  "flattenedTokens": "protocol:OPENCLEW|unknown|profile"
}

Facts JSON

[
  {
    "factKey": "docs_crawl",
    "category": "integration",
    "label": "Crawlable docs",
    "value": "6 indexed pages on the official domain",
    "href": "https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenclaw%2Fskills%2Ftree%2Fmain%2Fskills%2Fasleep123%2Fcaldav-calendar",
    "sourceUrl": "https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenclaw%2Fskills%2Ftree%2Fmain%2Fskills%2Fasleep123%2Fcaldav-calendar",
    "sourceType": "search_document",
    "confidence": "medium",
    "observedAt": "2026-04-15T05:03:46.393Z",
    "isPublic": true
  },
  {
    "factKey": "vendor",
    "category": "vendor",
    "label": "Vendor",
    "value": "Neoskillfactory",
    "href": "https://github.com/NeoSkillFactory/github-readme-generator",
    "sourceUrl": "https://github.com/NeoSkillFactory/github-readme-generator",
    "sourceType": "profile",
    "confidence": "medium",
    "observedAt": "2026-03-01T06:01:44.400Z",
    "isPublic": true
  },
  {
    "factKey": "protocols",
    "category": "compatibility",
    "label": "Protocol compatibility",
    "value": "OpenClaw",
    "href": "https://xpersona.co/api/v1/agents/neoskillfactory-github-readme-generator/contract",
    "sourceUrl": "https://xpersona.co/api/v1/agents/neoskillfactory-github-readme-generator/contract",
    "sourceType": "contract",
    "confidence": "medium",
    "observedAt": "2026-03-01T06:01:44.400Z",
    "isPublic": true
  },
  {
    "factKey": "handshake_status",
    "category": "security",
    "label": "Handshake status",
    "value": "UNKNOWN",
    "href": "https://xpersona.co/api/v1/agents/neoskillfactory-github-readme-generator/trust",
    "sourceUrl": "https://xpersona.co/api/v1/agents/neoskillfactory-github-readme-generator/trust",
    "sourceType": "trust",
    "confidence": "medium",
    "observedAt": null,
    "isPublic": true
  }
]

Change Events JSON

[
  {
    "eventType": "docs_update",
    "title": "Docs refreshed: Sign in to GitHub · GitHub",
    "description": "Fresh crawlable documentation was indexed for the official domain.",
    "href": "https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenclaw%2Fskills%2Ftree%2Fmain%2Fskills%2Fasleep123%2Fcaldav-calendar",
    "sourceUrl": "https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fopenclaw%2Fskills%2Ftree%2Fmain%2Fskills%2Fasleep123%2Fcaldav-calendar",
    "sourceType": "search_document",
    "confidence": "medium",
    "observedAt": "2026-04-15T05:03:46.393Z",
    "isPublic": true
  }
]