General documentation improvements for readme file#1606
Conversation
Co-authored-by: clairernovotny <1427284+clairernovotny@users.noreply.github.com>
There was a problem hiding this comment.
@copilot Overall looks good but for the downloads, make sure to use Humanizer.Core as the source for that. And for the options table, use the dotnet command
There was a problem hiding this comment.
Pull Request Overview
This PR significantly improves the Humanizer readme file with comprehensive documentation enhancements based on user feedback. The changes focus on making the readme more professional, user-friendly, and informative for both new and experienced developers.
Key changes include:
- Added professional badges section with build status, NuGet version, and download metrics
- Improved framework support documentation with clearer explanations of compatibility limitations
- Replaced language packages bullet list with a comprehensive markdown table format
readme.md
Outdated
| The following frameworks are supported: net48, net6.0, net7.0, and net8.0 | ||
|
|
||
| Note: The nuget also targets netstandard2. This is to enable scenario where netstandard2 is required. For example Roslyn Analyzers or MSBuild tasks. Other frameworks (other than listed above) that can consume netstandard2 (example net4.6.1 through to net 4.7.2) are not supported. For example net4.6.1 through to net4.7.2 are not supported. | ||
| The NuGet package also targets netstandard2.0 to support specific scenarios such as Roslyn Analyzers and MSBuild tasks that require netstandard2.0. While other .NET Framework versions (net4.6.1 through net4.7.2) can technically consume netstandard2.0 libraries, they are **not officially supported** by Humanizer and may not work correctly. Please use one of the explicitly supported frameworks listed above for the best experience. | ||
|
|
There was a problem hiding this comment.
[nitpick] The framework support explanation could be clearer. Consider restructuring to first state what IS supported, then explain the netstandard2.0 targeting as a special case, and finally clarify the unsupported versions.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@copilot The framework support explanation could be clearer. Consider restructuring to first state what IS supported, then explain the netstandard2.0 targeting as a special case, and finally clarify the unsupported versions. |
…ands, and clearer framework support Co-authored-by: clairernovotny <1427284+clairernovotny@users.noreply.github.com>
Restructured the framework support section with clear headings:
This makes it much easier to scan and understand. (commit: 5ac7052)
Updated! Changed the downloads badge to use Humanizer.Core and replaced Install-Package commands with dotnet add package commands in the table. (commit: 5ac7052) |
Updated NuGet badge links to include logo and prerelease information.
nuget.orgtowww.nuget.orgC#tocsharpfor better highlighting (96 occurrences)Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.