cefsharp / CefSharp

.NET (WPF and Windows Forms) bindings for the Chromium Embedded Framework
http://cefsharp.github.io/
Other
9.82k stars 2.92k forks source link

NuGet - Add README file #4713

Open lyndaidaii opened 7 months ago

lyndaidaii commented 7 months ago

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 commented 7 months ago

Here is list of packages that are top installed in NuGet.org: cefsharp.winforms cefsharp.wpf cefsharp.winforms.netcore cefsharp.wpf.netcore cefsharp.common.netcore

Appreciate if you could include README for your mapster packages, it is top installed packages on NuGet.org. It really helps customers to get started with your packages.

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.