Add README to NuGet package

[loic-sharma]

Hello!

I am from the NuGet team at Microsoft. We recently introduced support for embedding READMEs into NuGet packages (blog, docs), and we plan to place these READMEs front and center on nuget.org. Would you be willing to accept a contribution to add an embedded READMEs to the Moq package?

[stakx]

Hi @loic-sharma. Sounds great!

One thing, Moq packages are potentially released from two different repositories: this one here (moq/moq4), and moq/moq. I suppose the README.md from the package last pushed "wins"? Or the one from the latest version?

We'd need to make sure that if we actually do publish from both repositories, the Readme section on NuGet won't randomly change.

/cc @kzu (for the moq/moq repo)

[loic-sharma]

Oh I didn't know y'all were working on a new version of Moq! READMEs are version-specific. In other words, if V4 has README foo and V5 has README bar, we will show foo if you browse V4 and bar if you browse V5. I'll send pull requests to both repositories! :)

[stakx]

I see, and since NuGet displays the latest version by default, one would typically see the bar README once Moq v5 has been officially released. Makes sense! 👍

[stakx]

I'm closing this issue as it has gone stale. @loic-sharma (or anyone else), if you're still interested in adding a README to the Moq NuGet package, feel free to submit a PR.