From 1f3ec1d18ff4193d814c91cb00c0dd2adf2f6b07 Mon Sep 17 00:00:00 2001 From: samjanny Date: Wed, 3 Jun 2026 15:59:14 +0200 Subject: [PATCH] docs: link the end-to-end example from the top of the README Add a prominent pointer to examples/blog near the top, so a new reader reaches the runnable end-to-end walkthrough first. Also drop the stale '(Stage 6)' qualifier from verify in the command table: verify now drives the full manifest pipeline and checks content against the manifest runtime key. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bc636ac..2bfde91 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ Publisher command-line tooling for the [Entangled v1.0](https://github.com/samjanny/entangled) protocol, built on the [`entangled-core`](https://github.com/samjanny/entangled-api) library (pinned to tag `v0.10.0`, spec `v1.0-rc.48`). +**New here?** [`examples/blog`](examples/blog) is a runnable, end-to-end walkthrough: it authors a post from Markdown, signs the content and the site manifest, and verifies both. It is the quickest way to see what the tool does and how the pieces fit together. + ## Subcommands | Command | Status | Purpose | @@ -9,7 +11,7 @@ Publisher command-line tooling for the [Entangled v1.0](https://github.com/samja | `keygen` | working | Key ceremony: derive public material for a role | | `content` | working | Convert Markdown into an unsigned content document | | `build` | working | Construct and sign a manifest, content, or transaction | -| `verify` | working (Stage 6) | Run the validation pipeline against a document | +| `verify` | working | Run the validation pipeline against a document | | `init` | working | Scaffold a new site | ### `keygen [--seed-file ] [--seed-hex <64 hex>]`