Skip to content

docs: rewrite README in plainer language - #28

Merged
mz-real merged 1 commit into
masterfrom
docs/readme-plain-language
Sep 25, 2026
Merged

mz-real merged 1 commit into
masterfrom
docs/readme-plain-language

Conversation

@mz-real

@mz-real mz-real commented Sep 25, 2026

Copy link
Copy Markdown
Owner

Summary

  • Rewrites the README prose so it reads more naturally:
    • no em or en dashes
    • much less bold
    • shorter sentences
    • the long ssr paragraph is now a short list
    • "Why this one?" becomes "How it compares"
  • All code samples, tables, APIs and technical details are unchanged.
  • CHANGELOG version headings use the standard ## [x.y.z] - date separator.

Docs only.

Test plan

  • No em or en dashes remain in the README
  • Every section, code sample and table from the old README is still present
  • CI

Same content and examples, written more directly: no em dashes, far
less bold, shorter sentences, and the ssr notes split into a short list.
CHANGELOG version headings use the standard ' - ' separator.
@mz-real
mz-real merged commit 5823a6a into master Sep 25, 2026
5 checks passed
@mz-real
mz-real deleted the docs/readme-plain-language branch September 25, 2026 21:52
@mz-real mz-real mentioned this pull request Sep 25, 2026
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