Skip to content

docs: improve README first impression with problem/fix diagrams - #109

Merged
its-mash merged 1 commit into
mainfrom
chore/improve-readme-messaging
Feb 17, 2026
Merged

docs: improve README first impression with problem/fix diagrams#109
its-mash merged 1 commit into
mainfrom
chore/improve-readme-messaging

Conversation

@its-mash

Copy link
Copy Markdown
Member

Summary

  • Lead with value proposition instead of a screenshot
  • Add boxed ASCII diagrams: "The Problem" (4 duplicate configs, plain-text keys) → "The Fix" (single gateway architecture)
  • Move dashboard screenshot after diagrams so visitors understand context
  • Mention instant client sync (no restart) and lightweight Rust footprint

Before

Tagline → screenshot → problem text (below fold)

After

Tagline → problem diagram → fix diagram → screenshot (reinforces understanding)

Test plan

  • Preview README on GitHub — verify box-drawing chars render in code blocks
  • Check mobile rendering

Lead with the value proposition instead of a screenshot. Add boxed
ASCII diagrams showing "The Problem" (4 duplicate configs, plain-text
keys) and "The Fix" (single gateway architecture). Move dashboard
screenshot after the diagrams so visitors understand what they're
looking at. Mention instant client sync and lightweight Rust footprint.

Signed-off-by: its-mash <mash@mcpmux.com>
Signed-off-by: Mohammod Al Amin Ashik <maa.ashik00@gmail.com>
@its-mash
its-mash merged commit b15482b into main Feb 17, 2026
11 checks passed
@its-mash
its-mash deleted the chore/improve-readme-messaging branch February 17, 2026 08:22
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