Skip to content

docs: rewrite the README - #397

Merged
oglassdev merged 1 commit into
mainfrom
claude/youthful-curie-55kzzm-readme
Sep 26, 2026
Merged

oglassdev merged 1 commit into
mainfrom
claude/youthful-curie-55kzzm-readme

Conversation

@oglassdev

Copy link
Copy Markdown
Owner

The old README's status section was one long paragraph of implementation detail. It was hard to scan and didn't show the latest work: one-to-one relationships, six-locale writes, saved-query preservation and the cleanup.

The new README covers:

The detailed bounds are unchanged and still live in the CLI guide, docs/plans/V1_SCOPE.md and docs/PROVENANCE.md. This is separate from #396, which updates V1_SCOPE.md.

This PR changes documentation only; no tool reads the README. The library example is copied from the lib.rs doctest, but the README copy is not compiled.

🤖 Generated with Claude Code

https://claude.ai/code/session_01NjC9DQYyzAeaWY2BKVU6ma


Generated by Claude Code

Replace the dense status paragraphs with a short overview: what the
library reads, creates and updates, what is out of scope, CLI and library
quick starts, repository layout and development commands. Detailed bounds
stay in the CLI guide, V1_SCOPE and PROVENANCE.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NjC9DQYyzAeaWY2BKVU6ma
@oglassdev
oglassdev merged commit 248d7ea into main Sep 26, 2026
10 checks passed
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.

2 participants