docs: rewrite README with professional layout and badges#128
Merged
Conversation
added 3 commits
July 14, 2026 21:40
- Restructure with centered header and clean badge row - Add shields.io badges: PyPI, Python versions, License, Downloads, Code Style, PRs Welcome, Issues - Add navigation links (Getting Started, Documentation, Contributing) - Condense features into a clean table format - Add collapsible metric details sections - Simplify CLI reference to essential commands - Add Contributing section with fork/PR workflow - Add Community section with docs, issues, discussions links - Improve overall readability and professional tone
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
Rewrites the README with a clean, professional layout optimized for contributor engagement and readability.
Changes
<details>tags for retrieval, generation, performance & costBefore → After
Testing