Add badges in README to show status and statistics of the project. #75
Conversation
WalkthroughThe changes in this pull request primarily involve updates to the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant README
User->>README: View README.md
README->>User: Display badges for downloads and build status
README->>User: Show compatibility information (Python 3.7+)
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
README.md (1)
339-341: Consider adding trailing newline and removing trailing space.The reference links are properly defined, but there are a couple of minor formatting issues:
- Line 340 has a trailing space
- The file should end with a newline character
Apply this diff to fix the formatting:
[clp-ffi-py-total-downloads]: https://static.pepy.tech/badge/clp-ffi-py -[clp-ffi-py-monthly-downloads]: https://static.pepy.tech/badge/clp-ffi-py/month +[clp-ffi-py-monthly-downloads]: https://static.pepy.tech/badge/clp-ffi-py/month [pepy/clp-ffi-py]: https://pepy.tech/project/clp-ffi-py +
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- README.md (2 hunks)
🔇 Additional comments (2)
README.md (2)
3-4: LGTM! The badges are properly placed and formatted.The download badges are strategically positioned at the top of the README, making them immediately visible to users. The markdown syntax is correct, and the badges will render properly.
3-4: Verify badge URLs are accessible.Let's ensure all URLs are accessible and returning the expected content.
Also applies to: 339-341
✅ Verification successful
Let me verify the redirect location for the pepy.tech project page to ensure it's properly redirecting.
Badge URLs are accessible and functional
All URLs are working as expected:
- Badge image URLs return 200 status codes
- Project page properly redirects from pepy.tech to www.pepy.tech/projects/clp-ffi-py with a final 200 status
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify that all badge-related URLs are accessible # Test badge image URLs echo "Checking badge image URLs..." curl -s -I "https://static.pepy.tech/badge/clp-ffi-py" | head -n 1 curl -s -I "https://static.pepy.tech/badge/clp-ffi-py/month" | head -n 1 # Test pepy.tech project page echo "Checking pepy.tech project page..." curl -s -I "https://pepy.tech/project/clp-ffi-py" | head -n 1Length of output: 385
Script:
#!/bin/bash # Follow redirects to get final URL for pepy.tech project page curl -s -L -I "https://pepy.tech/project/clp-ffi-py" | grep -i "location\|http/"Length of output: 202
LinZhihao-723
changed the title
LinZhihao-723
changed the title
References
Description
This PR adds badges in README to show:
Validation performed
Ensure README.md is successfully rendered the added badges.
Summary by CodeRabbit
Summary by CodeRabbit