Skip to content

docs: clarify README — open format, accurate framing, more competitors#41

Merged
liam-machine merged 1 commit into
mainfrom
ship/readme-format-clarity
May 6, 2026
Merged

docs: clarify README — open format, accurate framing, more competitors#41
liam-machine merged 1 commit into
mainfrom
ship/readme-format-clarity

Conversation

@liam-machine
Copy link
Copy Markdown
Owner

Summary

  • Drop the "three places that don't talk to each other" overclaim — the third bullet (your head) is exactly the thing that talks between the other two. Lead-in is now just "the context lives in three places:" and the bullets carry the punchline.
  • Add a paragraph in The solution naming the format as plain YAML and JSON — AI reads it natively, git diffs it cleanly, the canvas is just the human-readable view. Reinforces "no proprietary format, no lock-in" and hands off to the moat paragraph.
  • Add Erwin and DbSchema alongside SqlDBM in the competitor list so dedicated modelling-tool users (not just dbdiagram/Lucidchart) see themselves.

Test plan

  • Render README on GitHub and skim the problem and solution sections for flow.

🤖 Generated with Claude Code

Three small fixes layered on the moat polish: drop the "three places
that don't talk to each other" overclaim (the third bullet — your head —
already explains the bridge), name the format as plain YAML and JSON so
readers see there is no proprietary lock-in, and add Erwin and DbSchema
alongside SqlDBM so a wider band of modelling-tool users sees themselves
on the list.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@liam-machine liam-machine merged commit 6bb2d2f into main May 6, 2026
2 checks passed
@liam-machine liam-machine deleted the ship/readme-format-clarity branch May 6, 2026 12:47
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