Improve package readme

[thompson-tomo]

Summary

I wish for the base nuget package to have a more informative readme.

Details

The base nuget package should be using the same readme as the repo to make it as easy as possible for a user to get started with the package.

[jskeet]

I disagree with the premise here. I think a website readme and a package readme have different purposes. I can agree with the summary in this issue, but not the details.

I view a package readme as something which should:

• Give enough information for the user to decide whether or not this is a useful package for them
• Tell them where to find more information

A lot of the README doc at the moment really isn't aimed at the average NuGet consumer - it's about governance of CloudEvents etc.

I think we should have a dedicated NuGet-specific README instead, with:

• A succinct summary of the package
• A single example (and we'll need to think about how to choose that)
• A link to the user guide
• A link to the repo root

I think that would be more useful to a NuGet consumer than the current full README.

In an ideal world, we'd have a different example and summary for each package.