docs: rewrite the README around the security boundary and how to load it - #6
Merged
Merged
Conversation
JobInsight is a Chrome extension with no hosted demo, so the README now says that plainly and puts the unpacked-install steps where a live demo link would be. Adds a one-line description, CI/license/language badges, and five bullets on the decisions worth noticing — the Express proxy that keeps the OpenAI key out of the client and the origin gate CI tests, the MV3 content script / service worker / popup split, the 7-day per-job cache, structured six-field extraction, and the manifest validation that catches breaks invisible until reinstall. Backend quick start commands are taken verbatim from backend/package.json. The existing LinkedInFeed.png screenshot is kept; two further shots that would help are named with their paths and commented-out image lines. Co-Authored-By: Claude Opus 5 (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.
JobInsight is a Chrome extension with no hosted demo, so the README now says that plainly and puts the unpacked-install steps where a live demo link would otherwise be.
Added: a one-line description, CI / license / top-language badges (each verified 200), What it demonstrates technically, a Stack table, a backend Quick start, Status and License.
The five technical bullets, and where each is grounded:
/api/analyze—backend/server.js:120and the comment in.github/workflows/ci.ymlmanifest.jsonJOB_CACHE_TTL = 7 * 24 * 60 * 60 * 1000incontent/linkedin-scraper.js:24.github/workflows/ci.ymlChrome MV3, the Express proxy, Google OAuth, GPT-4o-mini and the 7-day cache all appear in the master career document (§5) and in the Software Engineer, ML/AI and IT resumes.
Backend quick start commands are copied verbatim from
backend/package.json. The existingscreenshots/LinkedInFeed.pngis kept and still renders. No metric was invented — the only number is the existing per-analysis cost estimate, carried over unchanged.Screenshots the owner needs to capture are listed in the README's Screenshots section, each with its target path and a pre-written, commented-out image line. Nothing in the README references an image that does not exist.
Only
README.md(and adocs/screenshots/README.mdplaceholder) is touched, to stay clear of the concurrent.project.json/ LICENSE work.🤖 Generated with Claude Code