Skip to content

README and home page explain Agentry to newcomers - #47

Merged
czj merged 1 commit into
mainfrom
claude/accessible-readme
Nov 6, 2026
Merged

czj merged 1 commit into
mainfrom
claude/accessible-readme

Conversation

@czj

@czj czj commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

The README and the home page were written for people who already use the browser gem. Someone who has never heard of either had no definition of a user agent, met a 120-line method list before learning what the gem is for, and a home page whose headline was "Same API as browser, faster".

Both now open with what Agentry does and what a User-Agent header is, then why to pick it, how to install it and a first example with its results. Reference material the guide and the Bots page already hold is summarized in a sentence with a link instead of being repeated.

  • README follows a reader's path: what it is, why Agentry (measured numbers kept exactly), installation, a first example, then bots, verified crawlers, Cloudflare and Client Hints, Accept-Language, middleware, cache, switching, performance, testing, development and license.
  • Reference moved to links: the full predicate list, Internet Explorer and Safari notes, aliases, the modern browser recipe and matcher removal live on guide.html and bots.html already. Cache, limits and eager_load! stay in the README, since the site does not cover them.
  • New testing section: says in plain words how browser's suite and the 20,328 user agent corpus check every answer.
  • Home page lede and order: new title, meta and og descriptions, byline "Who sent this request?", an intro sentence, Quick start moved above the numbers with return values, "What changes" renamed "Why Agentry" with a verified crawlers card in place of the cache card.
Checks

Every example result in the README and on the home page was run against lib/ (Safari 18.1 on iPhone, GPTBot, Claude-User, Googlebot with a Google IP, Cloudflare headers). script/highlight_docs.rb --check and script/render_docs.rb --check pass. Playwright at 1280 px and 390 px shows no horizontal scroll.

The README and the site's home page now start from what Agentry does and
define the User-Agent header before anything else. The full method list,
Internet Explorer and Safari notes, aliases and matcher recipes, already on
the guide and the Bots page, are summarized with links instead of repeated.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VLwjZvdTtyBSS7TRsQr9tf
@czj
czj merged commit 677e674 into main Nov 6, 2026
16 checks passed
@czj
czj deleted the claude/accessible-readme branch November 6, 2026 08:48
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