docs: enhance README with badges and Quick Look section#49
Merged
Conversation
- Add badges for Python version, FastAPI, Tests, License, and Coverage - Add Quick Look section with realistic gap detection example JSON - Include key metrics showing detection accuracy, cost savings, and performance - Improve visual appeal and accessibility for portfolio showcase 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Add LICENSE file with full GNU AGPL v3.0 text - Update README.md badge and license section - Update pyproject.toml license metadata and classifier - Update CLAUDE.md project metadata 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Change from /workflows/Tests/ to /actions/workflows/test.yml/ - Previous badge was looking for non-existent 'Tests' workflow - Actual workflow is named 'Run Tests' in test.yml - New format is more reliable and references the file directly 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <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.
Summary
Motivation
The README lacked visual indicators of project status and a concrete example of what the system actually outputs. These additions make it easier for viewers to quickly understand the project's tech stack, quality metrics, and real-world output format.
The license was changed to AGPL-3.0 to ensure that modifications to this network service remain open source and available to the community, which is particularly important for enterprise collaboration tools.
Changes
Test plan
🤖 Generated with Claude Code