Split README.md file for NLog.Web and NLog.Web.AspNetCore

[bakgerman]

Preview:

• https://github.com/bakgerman/NLog.Web/blob/nuget-enhancements/src/NLog.Web.AspNetCore/README.md
• https://github.com/bakgerman/NLog.Web/blob/nuget-enhancements/src/NLog.Web/README.md

[codecov-commenter]

Codecov Report

Base: 69% // Head: 69% // Decreases project coverage by -0% ⚠️

Coverage data is based on head (5835cc2) compared to base (a4ea473).
Patch has no changes to coverable lines.

❗ Current head 5835cc2 differs from pull request most recent head b1a0909. Consider uploading reports for the commit b1a0909 to get more accurate results

Additional details and impacted files

@@          Coverage Diff          @@
##           master   #898   +/-   ##
=====================================
- Coverage      69%    69%   -0%     
=====================================
  Files          66     66           
  Lines        1259   1259           
  Branches      323    323           
=====================================
- Hits          869    866    -3     
- Misses        246    251    +5     
+ Partials      144    142    -2     

Impacted Files	Coverage Δ
...utRenderers/AspNetRequestDurationLayoutRenderer.cs	58% <0%> (-7%)	⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[snakefoot]

The snupkg-file is already enabled in the build.ps1

I think the ReadMe.md should be very basic (without build-status-links etc.), and should look very similar to this:

https://www.nuget.org/packages/NLog.Web.AspNetCore#readme-body-tab

Maybe with some links like these:

• https://github.com/NLog/NLog.Web/releases
• https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-6
• https://nlog-project.org/config/?tab=layout-renderers&search=package:nlog.web.aspnetcore
• https://github.com/NLog/NLog/wiki/Logging-troubleshooting

[bakgerman]

Rolled back the snupkg changes to the csproj files. I will work on the README.MD files as you have suggested. Now that you have given link to proper readme content I think that will be fine.

[bakgerman]

Updated the README.MD files as requested

[bakgerman]

Is there any other changes that you would like me to perform?

[snakefoot]

I have no idea what the goal should be for the ReadMe in the nuget-package.

Would it make sense to expand a little on how to get help, besides the link to the basic troubleshooting-guide? Ex. using StackOverflow.com for NLog-related questions, and if wanting to contribute with new ideas / features then one is wellcome to create pull-requests ?

I guess there should also be some introduction about how awesome NLog.Web-extension-package actually is, and how it can solve all problems in the world (sales-pitch presentation)

[bakgerman]

Yes, let me ponder that and I will add some additional content regarding the topics mentioned above.

[snakefoot]

Since README.md will replace current package-description:

• https://github.com/NLog/NLog.Web/blob/master/src/NLog.Web.AspNetCore/NLog.Web.AspNetCore.csproj

Then I think <description> should be updated to this:

Integrates NLog as provider for Microsoft.Extensions.Logging, and provides NLog LayoutRenderers to enrich logging output with details from HttpContext.

Removing "details" about supported platforms.

[snakefoot]

These are my last nit-picks, and then this pull-request be merged right after.

Btw. think the badges looks great.

[bakgerman]

Thank you, for the comments.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[snakefoot]

@bakgerman Thank you again for all the hard work.

Thinking about preparing the last NLog-release for this year. Do you have any last code-changes?

[bakgerman]

No for this year, think health check pull request will be later in January.

[snakefoot]

Nuget-packages are now live:

• https://www.nuget.org/packages/NLog.Web.AspNetCore#readme-body-tab
• https://www.nuget.org/packages/NLog.Web#readme-body-tab

Think they look good!