Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add PyPI badges to README #11770

Merged
merged 3 commits into from
Jun 25, 2023
Merged

Add PyPI badges to README #11770

merged 3 commits into from
Jun 25, 2023

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jun 25, 2023

🤖 Generated by Copilot at 30bb8ac

Summary

📦🌐🎨

Added PyPI badges to README.md and README.zh-CN.md files to display package information. Changed code block language to bash for better readability.

README updated
Badges show version, downloads
Autumn harvest time

Walkthrough

  • Add badges for PyPI version and downloads to README files (link, link)

🛠️ PR Summary

Made with ❤️ by Ultralytics Actions

🌟 Summary

Enhancement of documentation with badges and command line code block syntax highlighting.

📊 Key Changes

  • Added a badge for the PyPI version and download statistics to the README.
  • Updated the command-line code block to bash syntax for better highlighting.

🎯 Purpose & Impact

  • Users can immediately see the current PyPI version of ultralytics and its download popularity, increasing transparency and trust. 🏷️
  • Improves the readability and accessibility of installation commands for users across different documentations (English and Chinese). 📝
  • These documentation improvements potentially attract more users by providing essential information at a glance and improve the overall user experience when setting up the tool. 🧑‍💻🌐

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
@glenn-jocher glenn-jocher changed the title Update README.md Add PyPI badges to README Jun 25, 2023
@glenn-jocher glenn-jocher merged commit 0acc5cf into master Jun 25, 2023
7 checks passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch June 25, 2023 16:04
NagatoYuki0943 added a commit to NagatoYuki0943/yolov5-ultralytics that referenced this pull request Jun 26, 2023
bandakopi pushed a commit to irajcode/yolov5 that referenced this pull request Jul 20, 2023
* Update README.md

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update README.zh-CN.md

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update README.zh-CN.md

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

---------

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
pleb631 pushed a commit to pleb631/yolov5 that referenced this pull request Jan 6, 2024
* Update README.md

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update README.zh-CN.md

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

* Update README.zh-CN.md

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>

---------

Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant