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

Improve README #25

Merged
merged 4 commits into from
Dec 5, 2023
Merged

Improve README #25

merged 4 commits into from
Dec 5, 2023

Conversation

pderrenger
Copy link
Member

@pderrenger pderrenger commented Dec 5, 2023

This pull request attempts to improve the repo README file with additional context and content.

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Enhanced 'ultralytics/assets' repository with updated branding, streamlined content, and clarified licensing options.

πŸ“Š Key Changes

  • πŸ†• Introduced new Ultralytics logo and removed the old banner image.
  • ✏️ Rewrote the introductory text to be more engaging and informative.
  • πŸ–ΌοΈ Added an image of open-source contributors.
  • πŸ” Detailed two licensing options: AGPL-3.0 for open-source use and an Enterprise License for commercial applications.
  • 🧰 Simplified the example code snippet for using pre-trained models.
  • πŸ“‘ Provided clear instructions for downloading and using datasets.
  • 🎨 Updated the social media icons and adjusted their layout for aesthetic improvements.

🎯 Purpose & Impact

  • πŸ–ŒοΈ Refocusing the brand image reflects a fresh and modern approach to Ultralytics' public representation.
  • πŸ“ˆ Enhanced readability and new contributor showcase can increase community engagement.
  • πŸ“‹ Clarifying the licensing terms ensures users can easily choose the right license for their needs, potentially expanding the user base.
  • πŸ’Ύ Streamlining code examples aids in ease of use for developers leveraging Ultralytics models.
  • 🌐 Refreshed social links reinforce the online presence and accessibility of the Ultralytics team.

@glenn-jocher glenn-jocher merged commit 7cb443f into main Dec 5, 2023
@glenn-jocher glenn-jocher deleted the update-readme-20231205224610 branch December 5, 2023 21:49
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.

2 participants