@dogsbay/artifact-viewer 0.0.0-stage → 0.2.0-beta.130

package/README.md

@@ -1,3 +1,26 @@
-# Temporary Holding Version
+# @dogsbay/artifact-viewer
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Publish a Dogsbay Markdown document as a claude.ai Artifact. The artifact holds a fixed viewer
+page, the `.md` and its images. The page renders the Markdown in the reader's browser, so an
+edit is a change to the `.md` alone.
+
+```bash
+npx -y @dogsbay/artifact-viewer guide.md                 # → guide.artifact/
+npx -y @dogsbay/artifact-viewer guide.md --start-review  # with a review baseline
+```
+
+Publish the folder with the Artifact tool: `index.html` as the page, the paths in
+`files.json` as its files (the folder as `root`), and the capability
+`{"comments":{"customAnchors":true}}`.
+
+What readers get:
+
+- the document rendered with `@dogsbay/render`, with Contents, Problems and Source;
+- comments anchored to source lines (`guide.md L12: …`), which Claude reads with each comment;
+- a **Changes** view of everything since a review round started (`guide.baseline.md`).
+
+Options: `--out <dir>`, `--start-review` (the document now is the baseline, with the time in
+`guide.baseline.json`), `--baseline <earlier.md>`. The output folder is replaced only when it is
+missing, empty, or an earlier pack's output.
+
+The `dogsbay-documents` skill (in `@dogsbay/render`) has the full recipe for agents.