Skip to content

docs: README rewrite, doc/ guides, attestation plans#15

Merged
indexzero merged 1 commit intomainfrom
docs
Mar 19, 2026
Merged

docs: README rewrite, doc/ guides, attestation plans#15
indexzero merged 1 commit intomainfrom
docs

Conversation

@indexzero
Copy link
Copy Markdown
Owner

@indexzero indexzero commented Mar 19, 2026

The README was lying

It described a v1 toy that slurps vibes. vlurp is a content ingress
layer with lineage tracking, integrity verification, threat scanning,
structured upgrades, and catalog diffing. The README should say that.

What changed

README.md — complete rewrite. Terminal-first aesthetic. ASCII art
header, install in one line, quick start with real terminal sessions
showing fetch/verify/scan/upgrade. Compact command table, flags, presets.
No emojis. No marketing. Shows the tool, doesn't describe it.

doc/ — four feature guides organized by workflow:

Guide What it covers
doc/fetch.md Sources, globs, presets, --ref, --as, --auto
doc/vlurpfile.md Batch processing, manifest format, intent vs reality
doc/supply-chain.md Lineage, verify, pin, scan, threat model
doc/upgrade.md outdated, diff, upgrade, catalog, catalog-diff

Attestation plans — three design docs for upcoming Sigstore work:

  • VLURP.ATTEST.PLAN.md — port nono-attest to JS via sigstore-js
  • NONO.ATTEST.PLAN.md — use nono CLI directly, vlurp orchestrates
  • ATTEST.H2H.md — side-by-side comparison, recommendation

All examples use real sources from dotvibes vlurping (obra/superpowers,
whilp/dotfiles, microsoft/amplifier, anthropics/skills, etc).

Test plan

  • README renders correctly on GitHub (ASCII art in code block)
  • All doc/ cross-links resolve
  • No references to removed examples
  • vlurp --help output is consistent with README commands table

The old README described a v1 toy. vlurp is not that anymore.

New README: terminal-first, no emojis, shows the tool working.
Install in one line, first fetch in three. Commands table, flags
table, presets table. Links out to doc/ for depth.

New doc/ guides organized by workflow:
- doc/fetch.md      fetching, filtering, presets, --ref, --as
- doc/vlurpfile.md  batch processing, manifest format
- doc/supply-chain.md  lineage, verify, pin, scan, threat model
- doc/upgrade.md    outdated, diff, upgrade, catalog, catalog-diff

Also adds the three attestation design docs (sigstore-js plan,
nono-direct plan, head-to-head comparison) for the upcoming
Sigstore integration work.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@indexzero indexzero merged commit e7e387d into main Mar 19, 2026
2 checks passed
indexzero added a commit that referenced this pull request Mar 19, 2026
The old README described a v1 toy. vlurp is not that anymore.

New README: terminal-first, no emojis, shows the tool working.
Install in one line, first fetch in three. Commands table, flags
table, presets table. Links out to doc/ for depth.

New doc/ guides organized by workflow:
- doc/fetch.md      fetching, filtering, presets, --ref, --as
- doc/vlurpfile.md  batch processing, manifest format
- doc/supply-chain.md  lineage, verify, pin, scan, threat model
- doc/upgrade.md    outdated, diff, upgrade, catalog, catalog-diff

Also adds the three attestation design docs (sigstore-js plan,
nono-direct plan, head-to-head comparison) for the upcoming
Sigstore integration work.

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@indexzero indexzero deleted the docs branch April 1, 2026 06:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant