ImageSharp.Drawing icon indicating copy to clipboard operation
ImageSharp.Drawing copied to clipboard

sixlabors.imagesharp.drawing is missing NuGet package README file

Open lyndaidaii opened this issue 1 year ago • 2 comments

We've noticed that your package on NuGet.org is missing a README file.

Why READMEs are Important

A README is essential for users to understand your package's purpose and functionality quickly. It's the first thing users see on NuGet.org and helps them decide if your package meets their needs.

Get Started with READMEs

How to Add a README

If you're new to NuGet READMEs, follow guidance on how to add one to your package.

How to write high quality of READMEs

Follow a blog post with README best practices and a template file to help you get started.

We Value Your Feedback

We value your feedback. If you encounter any issues or have suggestions, please reply to this issue.

Thank you for your contribution to the NuGet community.

lyndaidaii avatar Feb 09 '24 22:02 lyndaidaii

Hi @lyndaidaii the reason we do not embed a readme is because NuGet does not yet support HTML in the markdown files.

We rely on embedded HTML to correctly display the readme and do not want to maintain two separate files.

See this nearly 4 year old issue. https://github.com/NuGet/NuGetGallery/issues/8644

JimBobSquarePants avatar Feb 09 '24 22:02 JimBobSquarePants

Thank you for your feedback. Unfortunately, HTML support has been in backlog for a while due to security concern. Any specific HTML you want to support on NuGet.org. We consider supporting small of low risky HTML. Thanks again.

lyndaidaii avatar Feb 09 '24 23:02 lyndaidaii