docs: sharpen README first-screen positioning#10
Merged
Conversation
Add an audience line, an "At a glance" summary, and good-fit/not-a-fit guidance above the fold so a stranger can decide whether siftfy fits in seconds. No behavior changes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Show the input-to-output payoff before any setup, and demonstrate a real request-handler integration inline rather than only linking out. Docs-only. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
What
Strengthens the top of the README so a stranger can decide whether
siftfyfits before scrolling into setup details:Why
The OSS-readiness README audit flagged a weak first screen (missing audience + fit guidance). With this change it scores a clean
go(21/21 checks). Docs-only — no code or behavior changes.🤖 Generated with Claude Code