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

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

Merged
merged 26 commits into from
Dec 29, 2022
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
d9044e7
Enable snupkg file. Split README.md file into 2 files for NLog.Web a…
Nov 30, 2022
194c3fb
Forgot to change the path to README.md
Nov 30, 2022
42d8e60
Rollback snupkg from csproj files since this is in the build.ps1 file
Nov 30, 2022
5835cc2
Updated README.MD files to match https://www.nuget.org/packages/NLog.…
Dec 2, 2022
c5c4608
Merge branch 'NLog:master' into nuget-enhancements
bakgerman Dec 9, 2022
2dc11a4
Edited README.md files according to review comments
Dec 13, 2022
483cf1d
Edit files according to review
Dec 13, 2022
1f856ff
Added registration of NLog.Web into the NLog.config file
Dec 13, 2022
39eee8f
Move Useful Links to bottom of the README.md files
Dec 13, 2022
3c3f7dd
Changed code markup to xml markup
Dec 13, 2022
e9bdb56
Fixed to refer to AspNetCore
Dec 13, 2022
c1903e6
Another fix for Core vs Framework
Dec 13, 2022
db96a23
addition of notes of capabilities and of support link and home page link
Dec 13, 2022
4bc86cb
Fix NLog.Web.AspNetCore registration example
Dec 13, 2022
ffac02f
Added statements about ability to log all http context and host envir…
Dec 14, 2022
a395e87
Further edits for the README.md files
Dec 15, 2022
419390a
Merge branch 'NLog:master' into nuget-enhancements
bakgerman Dec 15, 2022
29e26d4
Merge branch 'NLog:master' into nuget-enhancements
bakgerman Dec 20, 2022
4019b43
Remove readme.txt files since they have been replaced with readme.md …
Dec 28, 2022
22a1e2f
Merge branch 'NLog:master' into nuget-enhancements
bakgerman Dec 29, 2022
c30e0ed
Implement review comments
Dec 29, 2022
5fc3413
Forgot to make a link
Dec 29, 2022
40f67f5
Also mention http response logging for asp.net core case only.
Dec 29, 2022
1ffdd82
Adjustments for target and layout formats statements
Dec 29, 2022
43502d2
Merge branch 'NLog:master' into nuget-enhancements
bakgerman Dec 29, 2022
b1a0909
Restore main README.md file
Dec 29, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 0 additions & 93 deletions README.md

This file was deleted.

2 changes: 2 additions & 0 deletions src/NLog.Web.AspNetCore/NLog.Web.AspNetCore.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,11 @@ List of available Layout Renderers: https://nlog-project.org/config/?tab=layout-
<AssemblyTitle>$(Title)</AssemblyTitle>
<EmbedUntrackedSources>true</EmbedUntrackedSources>
<!-- EmbedUntrackedSources for deterministic build -->
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>
<ItemGroup>
<None Include="N.png" Pack="true" PackagePath="" Visible="false" />
<None Include="README.md" Pack="true" PackagePath=""/>
</ItemGroup>
<Target Name="DownloadMissingContent" BeforeTargets="GenerateNuspec">
<DownloadFile SourceUrl="https://nlog-project.org/N.png" DestinationFolder="$(MSBuildThisFileDirectory)" />
Expand Down
21 changes: 21 additions & 0 deletions src/NLog.Web.AspNetCore/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# NLog.Web.AspNetCore

- LoggerProvider for ASP.NET Core platform.
- Adds helpers and layout renderers for websites and web applications.

Supported platforms:

- For ASP.NET Core 6, .NET 6
- For ASP.NET Core 5, .NET 5
- For ASP.NET Core 3, .NET Core 3.1
- For ASP.NET Core 2, .NET Standard 2.0 and .NET 4.6.1+

Useful Links
- [Change Log](https://github.com/NLog/NLog.Web/releases)
- [Tutorial](https://github.com/NLog/NLog/wiki/Tutorial)
snakefoot marked this conversation as resolved.
Show resolved Hide resolved
- [Getting started with ASP.NET Core 6](https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-6)
- [Getting started with ASP.NET Core 5](https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-5)
- [Getting started with ASP.NET Core 3](https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-3)
- [Getting started with .NET Core 2 Console App](https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-2---Console-application)
snakefoot marked this conversation as resolved.
Show resolved Hide resolved
- [ASP.NET Core Layout Renderers](https://nlog-project.org/config/?tab=layout-renderers&search=package:nlog.web.aspnetcore)
- [Logging Troubleshooting](https://github.com/NLog/NLog/wiki/Logging-troubleshooting)
5 changes: 4 additions & 1 deletion src/NLog.Web/NLog.Web.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,13 @@ List of available Layout Renderers: https://nlog-project.org/config/?tab=layout-
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<AssemblyTitle>$(Title)</AssemblyTitle>
<DisableImplicitFrameworkReferences>true</DisableImplicitFrameworkReferences>
<EmbedUntrackedSources>true</EmbedUntrackedSources> <!-- EmbedUntrackedSources for deterministic build -->
<EmbedUntrackedSources>true</EmbedUntrackedSources>
<!-- EmbedUntrackedSources for deterministic build -->
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>
<ItemGroup>
<None Include="N.png" Pack="true" PackagePath="" Visible="false" />
<None Include="README.md" Pack="true" PackagePath=""/>
</ItemGroup>
<Target Name="DownloadMissingContent" BeforeTargets="GenerateNuspec">
<DownloadFile SourceUrl="https://nlog-project.org/N.png" DestinationFolder="$(MSBuildThisFileDirectory)" />
Expand Down
22 changes: 22 additions & 0 deletions src/NLog.Web/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# NLog.Web

- LoggerProvider for ASP.NET platform.
- Adds helpers and layout renderers for websites and web applications.

Supported platforms:
snakefoot marked this conversation as resolved.
Show resolved Hide resolved

The .NET 3.5 build supports the following .NET releases
snakefoot marked this conversation as resolved.
Show resolved Hide resolved
- .NET 3.5
- .NET 4.0
- .NET 4.5.0-2

The .NET 4.6 build supports the following .NET releases
- .NET 4.6.0-3
- .NET 4.7.0-2
- .NET 4.8.x

snakefoot marked this conversation as resolved.
Show resolved Hide resolved
Useful Links
- [Change Log](https://github.com/NLog/NLog.Web/releases)
- [Tutorial](https://github.com/NLog/NLog/wiki/Tutorial)
- [ASP.NET Layout Renderers](https://nlog-project.org/config/?tab=layout-renderers&search=package:nlog.web)
- [Logging Troubleshooting](https://github.com/NLog/NLog/wiki/Logging-troubleshooting)