What makes update-readme notable?

1.6K downloads. Trust evidence available

How should update-readme be evaluated before use?

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

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.

agentCLAWHUBUnverified

update-readme

Refreshes README structure and content using repo context and exemplar research Skill: update-readme Owner: athola Summary: Refreshes README structure and content using repo context and exemplar research Tags: latest:1.9.19 Version history: v1.9.19 | 2026-08-26T13:21:22.309Z | user Release v1.9.19 v1.9.17 | 2026-07-30T05:41:22.501Z | user Release v1.9.17 v1.9.16 | 2026-07-14T19:58:10.077Z | user Release v1.9.16 v1.9.14 | 2026-06-30T18:05:59.607Z | user Release v1.9.14 v1.9.13 | 2026-06-27T16:23:

OpenClaw

View on ClawHub Homepage

Rank

Safety

Downloads

1.6k

Updated

Oct 10, 2026

Version

1.9.19

Source

CLAWHUB

About

What it does, and when to use it.

Capability contract not published. No trust telemetry is available yet. 1.6K downloads reported by the source. Last updated 10/10/2026.

Avoid when

Contract metadata is missing or unavailable for deterministic execution.

Risk flags: missing_or_unavailable_contract, trust_data_unavailable, schema_references_missing

Public facts

Every fact links back to the source it came from.

Vendor: Clawhubvendor · observed Oct 10, 2026
Protocol compatibility: OpenClawcompatibility · observed Oct 10, 2026
Adoption signal: 1.6K downloadsadoption · observed Oct 10, 2026
Latest release: 1.9.19release · observed Aug 26, 2026
Handshake status: UNKNOWNsecurity

Install and run

Setup complexity: low.

clawhub skill install s17emme0e2m3cpf7k2jvp3a84984b8z9:nm-sanctum-update-readme

Setup complexity is classified as HIGH. You must provision dedicated cloud infrastructure or an isolated VM. Do not run this directly on your local workstation.
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.

Contract: missing

curl -s "https://www.xpersona.co/api/v1/agents/clawhub-athola-nm-sanctum-update-readme/snapshot"

Documentation

CLAWHUB

144,758 characters of source documentation, loaded on request.

Extracted files

5 files captured from the source.

SKILL.md

---
name: update-readme
description: Refreshes README structure and content using repo context and exemplar research
version: 1.9.8
triggers:
- readme
- documentation
- exemplars
- research
- structure
- README needs a structural update after significant project changes
metadata: {"openclaw": {"homepage": "https://github.com/athola/claude-night-market/tree/master/plugins/sanctum", "emoji": "\ud83e\udd9e", "requires": {"config": ["night-market.sanctum:shared", "night-market.sanctum:git-workspace-review", "night-market.imbue:proof-of-work", "night-market.scribe:slop-detector", "night-market.scribe:doc-generator"]}}}
source: claude-night-market
source_plugin: sanctum
---

> **Night Market Skill** — ported from [claude-night-market/sanctum](https://github.com/athola/claude-night-market/tree/master/plugins/sanctum). For the full experience with agents, hooks, and commands, install the Claude Code plugin.

# README Update Workflow

## When To Use
Use this skill whenever the README requires a structural refresh.
Run `Skill(sanctum:git-workspace-review)` first to capture repo context and diffs.

## When NOT To Use

- Updating inline docs: use doc-updates
- Consolidating ephemeral reports: use doc-consolidation

## Required TodoWrite Items
1. `update-readme:language-audit`
2. `update-readme:exemplar-research`
3. `update-readme:outline-aligned`
4. `update-readme:edits-applied`
5. `update-readme:slop-scanned` - AI marker detection via scribe
6. `update-readme:verification-reporting`

## Step 1 - Language Audit (`update-readme:language-audit`)
- Confirm `pwd`, `git status -sb`, and the baseline branch for reference.
- Detect dominant languages using repository heuristics (manifest files, file counts).
- Note secondary languages that influence documentation (e.g., a TypeScript frontend and a Rust backend) so the README can surface both.
- Record the method and findings.

See `modules/language-audit.md` for detailed detection patterns and commands.

## Step 2 - Exemplar Research (`update-readme:exemplar-research`)
- For each primary and secondary language, use web search to locate high-quality READMEs (star count, recency, maintainer activity).
- Capture 2-3 exemplar repositories per language and summarize why each is relevant (section order, visuals, quickstart clarity, governance messaging, math exposition, etc.).
- Store citations for every exemplar so the final summary references them explicitly.

See `modules/exemplar-research.md` for search query patterns and evaluation criteria.

## Step 3 - Outline Alignment (`update-readme:outline-aligned`)
- Compare current README headings (`rg -n '^#' README.md`) against patterns observed in exemplars.
- Draft a target outline covering: value proposition, installation, quickstart, deeper usage/configuration, architecture/feature highlights, performance or math guarantees, documentation links, contribution/governance, roadmap/status, and licensing/security notes.
- validate internal documents (docs/, spe

_meta.json

{
  "ownerId": "kn7d107jg9jv602h9ytsegydq184a42s",
  "slug": "nm-sanctum-update-readme",
  "version": "1.9.19",
  "publishedAt": 1787750482309
}

modules/exemplar-research.md

# Exemplar Research Patterns

Detailed patterns for finding, evaluating, and documenting high-quality README exemplars.

## Web Search Query Patterns

### Language-Specific Queries

```
"GitHub [language] README best practices"
"[language] framework README examples"
"[language] project README badges"
"[language] library documentation structure"
"awesome [language] README"
```

### Framework/Domain-Specific Queries

```
"[framework] README structure"
"[domain] project README examples" (e.g., "CLI tool README examples")
"[language] [project-type] documentation" (e.g., "Rust async library documentation")
```

### Quality Indicators

```
"high star count [language] README"
"well-maintained [language] project README"
"[language] project documentation best practices 2024"
```

## Exemplar Evaluation Criteria

Assess each candidate README using these dimensions:

### Structure & Organization
- **Section order**: Does it follow a logical progression (value → quickstart → details)?
- **Progressive disclosure**: Are complex topics deferred until after basics?
- **Table of contents**: Is it present and well-structured?
- **Visual hierarchy**: Clear heading levels, spacing, readability?

### Content Quality
- **Value proposition**: Clear statement of what the project does and why it matters?
- **Quickstart clarity**: Can a new user get started in <5 minutes?
- **Code examples**: Are they runnable, realistic, well-commented?
- **Installation steps**: Clear, tested, platform-aware?

### Technical Communication
- **Accuracy**: Does it match the actual codebase capabilities?
- **Completeness**: Coverage of installation, usage, configuration, troubleshooting?
- **Governance messaging**: Clear contribution guidelines, roadmap, support channels?
- **Math/algorithm exposition**: For technical projects, is the theory well-explained?

### Maintenance Signals
- **Recency**: Last commit within 6 months?
- **Star count**: Indicator of community validation (>500 stars preferred)
- **Maintainer activity**: Active issue responses, recent releases?
- **CI/CD badges**: Evidence of automated quality checks?

## Citation Format

Record each exemplar with full attribution:

```markdown
### Exemplar: [Project Name]
- **URL**: https://github.com/[org]/[repo]
- **Language**: [Primary language]
- **Stars**: [count] (as of [date])
- **Last Updated**: [date]
- **Relevant Patterns**:
  - [Pattern 1]: [Description and why it's relevant]
  - [Pattern 2]: [Description and why it's relevant]
  - [Pattern 3]: [Description and why it's relevant]
- **Specific Elements to Adapt**:
  - [Element]: [How it applies to this project]
```

## Storage Recommendations

### Temporary Research Notes
Store research findings in a temporary file during the session:

```bash
# Create research notes file
cat > /tmp/readme-research.md << 'EOF'
# README Exemplar Research

## [Language 1] Exemplars
[Citations...]

## [Language 2] Exemplars
[Citations...]
EOF
```

### Final Report Integration
Include exemplar cit

modules/language-audit.md

# Language Audit Patterns

Detailed patterns and commands for detecting project languages and their documentation implications.

## Manifest File Detection

Check for language-specific manifest files to identify the primary language(s):

```bash
# Rust
ls -1 Cargo.toml 2>/dev/null

# Node.js/TypeScript
ls -1 package.json 2>/dev/null

# Go
ls -1 go.mod 2>/dev/null

# Python
ls -1 pyproject.toml setup.py requirements.txt 2>/dev/null

# Java/Kotlin
ls -1 pom.xml build.gradle build.gradle.kts 2>/dev/null

# Ruby
ls -1 Gemfile 2>/dev/null

# PHP
ls -1 composer.json 2>/dev/null
```

## File Count Analysis

Count source files by extension to determine language distribution:

```bash
# Rust
git ls-files | rg '\.rs$' | wc -l
# or for preview
rg --files -g '*.rs' | head -10

# Python
git ls-files | rg '\.py$' | wc -l
rg --files -g '*.py' | head -10

# Go
git ls-files | rg '\.go$' | wc -l
rg --files -g '*.go' | head -10

# TypeScript/JavaScript
git ls-files | rg '\.(ts|tsx|js|jsx)$' | wc -l
rg --files -g '*.ts' -g '*.tsx' | head -10

# Java
git ls-files | rg '\.java$' | wc -l
rg --files -g '*.java' | head -10
```

## Language Priority Heuristics

Determine primary language using these priority rules:

1. **Manifest presence**: If a language-specific manifest exists, it's a strong signal
2. **File count dominance**: Language with >60% of source files is primary
3. **Directory structure**: Check for language-specific directories (src/, lib/, pkg/)
4. **Build configuration**: Presence of Makefile, CMakeLists.txt, or build scripts

## Secondary Language Handling

Document secondary languages when they:

- Represent >20% of codebase
- Serve distinct architectural roles (e.g., Rust backend + TypeScript frontend)
- Have their own build/test infrastructure
- Require separate installation or runtime considerations

### Example Multi-Language Documentation Strategy

```markdown
## Installation

### Backend (Rust)
[Rust-specific instructions]

### Frontend (TypeScript)
[Node/npm-specific instructions]
```

## Recording Findings

Capture the audit results in a structured format:

```
Language Audit Results:
- Primary: [Language] ([count] files, [manifest])
- Secondary: [Language] ([count] files, [manifest])
- Method: [manifest detection | file count | directory structure]
- Documentation implications: [single-language | multi-language sections needed]
```

skill-card.md

## Description:

Refreshes README structure and content using repo context and exemplar research.

This skill is ready for commercial/non-commercial use.

## Publisher:

[athola](https://clawhub.ai/user/athola)

### License/Terms of Use:

MIT-0

## Use Case:

Developers and documentation maintainers use this skill to audit a repository, research relevant README examples, and restructure README content with clearer installation, usage, governance, and verification sections.

### Deployment Geography for Use:

Global

## Known Risks and Mitigations:

Risk: README edits could introduce inaccurate or misleading project guidance.

Mitigation: Review the documentation diff, verify links and claims against repository files, and scan the final README before release.

Risk: The workflow uses web-based exemplar research and references external plugin dependencies.

Mitigation: Review cited exemplar sources and external plugin dependencies separately before relying on their recommendations.

Risk: Some trigger words are broader than the README update workflow itself.

Mitigation: Invoke the skill explicitly for README refresh tasks rather than relying only on broad trigger matching.

## Reference(s):

- [ClawHub skill page](https://clawhub.ai/athola/skills/nm-sanctum-update-readme)
- [Metadata homepage](https://github.com/athola/claude-night-market/tree/master/plugins/sanctum)

## Skill Output:

**Output Type(s):** [markdown, shell commands, guidance]

**Output Format:** [Markdown documentation edits with command snippets and verification notes]

**Output Parameters:** [1D]

**Other Properties Related to Output:** [May include citations for researched README exemplars and summaries of repository language findings.]

## Skill Version(s):

1.9.19 (source: server release metadata)

## Ethical Considerations:

Users should evaluate whether this skill is appropriate for their environment, review any generated or modified files before relying on them, and apply their organization's safety, security, and compliance requirements before deployment.

Github ReposUpdated 15h agoRank 70

AionUi

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!

MCPOPENCLAW

Github ReposUpdated 6mo agoRank 70

activepieces

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

OPENCLAW

Github ReposUpdated 6mo agoRank 70

cherry-studio

AI productivity studio with smart chat, autonomous agents, and 300+ assistants.