Add missing README - #1
Draft
badchars wants to merge 1 commit into
Draft
Conversation
This repo had no README at all. For a browser extension that requests broad webRequest/cookies/all_urls permissions, that is a discoverability and trust gap: visitors currently have no way to tell what it does or why it needs those permissions short of reading manifest.json and the source. Adds a minimal README covering purpose, install, and permissions.
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 does this PR do?
This repo has no README (only
manifest.json,background/,popup/,icons/,docs/,postman_collection.json). Generated from a scheduled SEO/discoverability review of the org's public repos. Not merged, for your review only.Adds a minimal README covering: what the extension does, how it plugs into CyberStrike's HackBrowser/proxy pipeline, install steps, and a plain-language note on why it requests broad permissions (
webRequest,<all_urls>,cookies,contextualIdentities).Why this matters beyond SEO: a security-adjacent browser extension with zero documentation and broad traffic-capture permissions is a trust red flag for anyone evaluating it (would-be users, AMO reviewers, security researchers browsing the org). A short README that plainly states what data it touches and where it goes closes that gap.
Please review the wording, especially the permissions paragraph, since I inferred its behavior from
manifest.jsonand the public README of the main CyberStrike repo rather than the extension's source.Type of change
Security impact
How did you verify it works?
New file only, no code changed. Content is based on
manifest.json's declared permissions and the HackBrowser section of the CyberStrikeus/CyberStrike README.Checklist
Part of a broader SEO/discoverability report also covering GitHub topics and About descriptions for this repo and the org's other public repos. Full report sent separately for review.