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

xrm.sdk.pluginregistration is missing NuGet package README file #139

Open
lyndaidaii opened this issue Feb 12, 2024 · 1 comment
Open

xrm.sdk.pluginregistration is missing NuGet package README file #139

lyndaidaii opened this issue Feb 12, 2024 · 1 comment
Assignees

Comments

@lyndaidaii
Copy link

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.

imranakram added a commit that referenced this issue Feb 19, 2024
@imranakram imranakram self-assigned this Feb 19, 2024
imranakram added a commit that referenced this issue Feb 19, 2024
* #139 Added `README.md` to nuget

* Updated `.nuspec`
@imranakram
Copy link
Collaborator

imranakram commented Feb 20, 2024

@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? :)

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