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

sixlabors.imagesharp.drawing is missing NuGet package README file #319

Open
lyndaidaii opened this issue Feb 9, 2024 · 2 comments
Open

Comments

@lyndaidaii
Copy link

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.

@JimBobSquarePants
Copy link
Member

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.
NuGet/NuGetGallery#8644

@lyndaidaii
Copy link
Author

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.

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

No branches or pull requests

2 participants