Repository navigation
README: start from what the gem does, for readers new to it - #46
Merged
Merged
Conversation
The README opened on browser's history and benchmark numbers, then a 100-line method list. It now says what Agentry does in its first line, shows a request answered, then where the gem comes from and what it adds, before installation and usage. Every section is rewritten in plain sentences: no bold lists, no em dashes, no filler, with the facts and numbers unchanged. It also covers the reverse DNS cache, the headers: argument in the way back to browser, and the signed-tag check of a release. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VLwjZyWmQL6GwpLmowWPVn
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README assumed its reader already knew the browser gem. It opened on a comparison with browser and benchmark numbers, then a 120-line method list, and it had no example of what a call returns. Its prose leaned on bold bullet lists and em dashes, two of the signs Wikipedia: Signs of AI writing lists, and upstream's older sections had typos ("an user", "a initializer").
The first line now says what Agentry does. A short example shows real answers for an iPhone user agent, verified against the current code. Next come a section on where the gem comes from and what it adds, then installation, with the conflict with
gem "browser"explained, and usage, starting with the Rails helper. The method list and every later section are rewritten in plain sentences with sentence-case headings. Facts, numbers, code and links are unchanged.dns_cache_size,dns_cache_ttl,dns_timeout), the spoofing caveat for the Cloudflare headers, theheaders:argument in the way back to browser, and the signed-tag check of a release.Checked
The example outputs come from running the snippet against
main(Safari,18,iOS (iPhone),fr-FR; GPTBot givesChatGPT,:ai_crawler). The rewritten README has no em dashes, en dashes, curly quotes or**, and none of the AI-vocabulary words the page lists. Every number (25 µs, 126 µs, 882, 353, 11, 600, 792, 13 ms) is the one the previous README gave.