Skip to content

README: one definition, one quickstart, inline demo video, lighter first screen - #807

Merged
keysersoft merged 2 commits into
mainfrom
keysersoft/readme-v2
Sep 30, 2026
Merged

keysersoft merged 2 commits into
mainfrom
keysersoft/readme-v2

Conversation

@keysersoft

Copy link
Copy Markdown
Contributor

The README had grown to 4,589 words (the median of 20 comparable repos is ~1,160) and said the same things several times: the quickstart twice, response mapping four times, the Knowledge Graph three times. Its 3.7 MB GIF loaded eagerly and repeated the banner's diagram, and 41 root entries pushed the README 2,086 px down the page.

README (en, de, zh-CN, ja)

  • One definition sentence up top ("AnythingMCP is an open-source, self-hosted MCP gateway that…"), a category in the H1, 4 badges instead of 7, and a link row with the Cloud trial, self-hosting, docs and guides.
  • The demo is now the full 2:40 film with sound as a GitHub-hosted mp4 that plays inline (9 MB, 720p, poster as the first frame). The GIF is deleted; export-web.py produces the mp4 instead.
  • One quickstart, a 3-step "How it works" (which replaces the glossary), one table for connector types, the ERP and e-commerce tables folded in <details>, one security section, one section for Claude/ChatGPT/Copilot/Gemini, FAQ questions as H3.
  • The named competitor table is replaced by a short "Where it fits" paragraph plus a link to anythingmcp.com/vs; the comparisons live on the site.
  • Fixes the 7-vs-8 database engines contradiction and adds the llms.txt link.
  • README.md is 2,984 words, 2,270 of them outside the folded tables; the rendered README is 7,600 px instead of 13,300.

Assets and layout

  • README banners are written as 256-colour PNGs without dithering: ~89 KB instead of ~320 KB, no visible difference.
  • CONTRIBUTING, SECURITY, SUPPORT and CODE_OF_CONDUCT moved to .github/ (GitHub still shows the tabs), ADOPTERS, AUTHORS and ROADMAP to docs/, video/demo to scripts/demo-video. CLA.md stays in the root because the CLA workflow and existing signatures link to it. Links, CODEOWNERS and .gitattributes updated; README anchors in docs fixed.
  • adapter-count.mjs --check expectations updated for the rewritten translations.
  • The repo's About (synced from .github/repo-about.txt) now leads with "self-hosted MCP gateway" and OpenAPI.

…rst screen

- Rewrite README.md (and de, zh-CN, ja) around a single definition sentence,
  one quickstart, a 3-step how-it-works and a merged security section; the
  ERP and e-commerce tables are folded, the Claude/ChatGPT sections merged,
  the named competitor table replaced by a link to /vs, FAQ questions as H3
- Replace the 3.7 MB GIF with the full demo as a GitHub-hosted mp4 (9 MB,
  plays inline, poster as first frame); export-web.py now produces it
- Write the README banners as 256-colour PNGs (~90 KB instead of ~320 KB)
- Move community files to .github/ and ADOPTERS/AUTHORS/ROADMAP to docs/,
  video/demo to scripts/demo-video, so the README starts higher on the page
- Fix the 7-vs-8 database engines contradiction and stale README anchors
@keysersoft
keysersoft merged commit fdfc5a2 into main Sep 30, 2026
14 checks passed
@keysersoft
keysersoft deleted the keysersoft/readme-v2 branch September 30, 2026 20:32
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 30, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant