Repository navigation
docs: product-first README rewrite with live screenshot - #2
Merged
Merged
Conversation
Part of a GitHub profile improvement pass (task H02a). The previous README led with feature lists rather than a clear problem statement, so this rewrite front-loads: what problem the app solves and for whom, a screenshot and live demo link, the product decisions behind the architecture, an honest account of test/CI coverage (163 passing Vitest tests, no e2e yet), verified local setup steps, current limitations, and data provenance/ licensing status (no LICENSE file yet — left for a separate pass). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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.
Summary
Part of a broader GitHub profile improvement pass (task H02a). This repo's README led with a long feature list rather than a clear statement of the problem it solves, so this PR rewrites it to front-load, in order:
docs/screenshot.png)src/lib/match-scoring.ts, etc.).github/workflows/quality.yml) that runs test/lint/build on every PR and push tomain, and an explicit note that there's no end-to-end/browser test suite yetnpm installandnpm testfresh from a clean clone (163/163 passing)LICENSEfile, which is stated plainly rather than assuming or inventing a license; a separate licensing pass will address that.No other repo settings were touched (visibility, topics, pins, account settings are out of scope for this change).
Test plan
npm install+npm test— 163/163 tests passed.github/workflows/quality.ymlto confirm CI runs test/lint/buildnpm run buildagainst a real Postgres database was not re-verified in this pass (no database was provisioned for this change) — CI already covers this on every push🤖 Generated with Claude Code