docs: lead the README with what ZYNLEX is and who it's for - #23
Merged
Merged
Conversation
Search engines and AI summaries were describing ZYNLEX from SECURITY.md, whose opening listed traffic interception, header injection and HttpOnly cookie editing, so it read as a proxy or security-testing tool. - README: plain-text intro under the tagline, mock responses near the top of the feature list, "Who it's for" and "How it compares" sections, installer size corrected to 3.6 MB. - SECURITY.md: open with what the policy covers and link the README, instead of a list of attack surface.
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.
Why
Google and AI search answers were describing ZYNLEX from
SECURITY.mdrather than the README, and framing it as an "HTTP manipulation proxy" / Burp-style security tool. SECURITY.md's opening paragraph was the densest plain-prose description of the project anywhere in the repo, and it was a list of attack surface. The README opened with a logo, badges and a GIF, with almost no text to summarise.Changes
Docs only.