You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We've noticed that your package on NuGet.org is missing a README file.
Why READMEs are Important
Our customer research indicates that one of the top problems that package consumers face is insufficient package documentation such as README files. Adding a README file to your package will help users quickly understand what the package is and what it does. Since your README will be the first impression for users when they view your package on NuGet.org, it is crucial for authors to write and include high-quality READMEs for their packages.
@lyndaidaii Thanks for this. Could you please elaborate on what should be put for license info? The official nuget has a .docx file as license info, should we use the same or MIT?
Any plans on open sourcing the official tool though? :)
We've noticed that your package on NuGet.org is missing a README file.
Why READMEs are Important
Our customer research indicates that one of the top problems that package consumers face is insufficient package documentation such as README files. Adding a README file to your package will help users quickly understand what the package is and what it does. Since your README will be the first impression for users when they view your package on NuGet.org, it is crucial for authors to write and include high-quality READMEs for their packages.
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.
The text was updated successfully, but these errors were encountered: