bogus is missing NuGet package README file

[lyndaidaii]

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.

[bchavez]

Hello, thank you for the suggestion.

However,

• It looks like NuGet README renders CommonMark not GitHub Flavored Markdown (GFM); and my personal preference is using GFM over CommonMark.
• The current README for this NuGet package is here: https://github.com/bchavez/Bogus/blob/master/README.md
  • and is good enough (and prefer it over a NuGet README) because if there's any issue with the code or documentation, the user is already on GitHub and can file a support or discussion GH issue more easily than being on the nuget.org website; just like the recent GH Issue and PR:
    • Docs: Add inclusive / exclusive number ranges documentation for Randomizer #529
    • Are Randomizer's number ranges inclusive or exclusive? #528
  • also, the current README for this repo is probably not compatible with CommonMark so there might be some unknown amount of work to make it compatible with nuget.org README; which I'm not willing to do.
• I do not want to maintain two READMEs or worry about having them get out of sync.
• Also, it looks like you might be using some kind of automation or bot to massively post across multiple repositories on GitHub:
  • https://github.com/lyndaidaii?tab=overview&from=2024-02-01&to=2024-02-09
    

Finally, I would like to politely ask that you refrain from using automated software for the creation of GitHub issues on my code repositories. It is not very personable or sincere asking me to do work this way.

For these reasons I'm going to close this issue as "wontfix"/invalid; but feel free to continue the thread if my assumptions/points are wrong. Thank you.