docs: add badges and table of contents to README#22
Merged
warproxxx merged 1 commit intowarproxxx:mainfrom Apr 27, 2026
Merged
Conversation
Author
|
Hi! Just checking in — happy to make any changes if needed. Let me know if you have any feedback. 🙌 |
Owner
|
Good idea. Merged. Thank you! |
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
2 participants
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 this PR does
Adds status badges and a table of contents to the README for better discoverability and navigation.
Why
The README currently has 12+ sections but no table of contents, making it difficult for new users to navigate to the section they need (e.g., jumping directly to Data Schema Details or Troubleshooting). Adding badges (license, stars, last commit, Python version) also helps visitors quickly assess project status at a glance — this is a common pattern in popular open-source projects.
Changes
🤖 This PR was created with AI assistance and reviewed by a human.