This is an automated email from the ASF dual-hosted git repository. lukaszzborek pushed a commit to branch csharp-nuget-readme in repository https://gitbox.apache.org/repos/asf/iggy.git
commit ea5b85e3698522980807f8fa26de7509bd4c896a Author: Łukasz Zborek <[email protected]> AuthorDate: Mon Sep 28 16:29:47 2026 +0200 docs(csharp): introduce simpler README for NuGet page nuget.org renders only Markdown, so the HTML logo header of the GitHub README showed up as raw text on the package page. Ship a short Markdown-only README.nuget.md as the package readme that points to the full README on GitHub. --- foreign/csharp/Iggy_SDK/Iggy_SDK.csproj | 6 +++--- foreign/csharp/README.nuget.md | 19 +++++++++++++++++++ 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/foreign/csharp/Iggy_SDK/Iggy_SDK.csproj b/foreign/csharp/Iggy_SDK/Iggy_SDK.csproj index f904ecd74..cf1d61bad 100644 --- a/foreign/csharp/Iggy_SDK/Iggy_SDK.csproj +++ b/foreign/csharp/Iggy_SDK/Iggy_SDK.csproj @@ -39,7 +39,7 @@ under the License. <RepositoryUrl>https://github.com/apache/iggy</RepositoryUrl> <PackageProjectUrl>https://github.com/apache/iggy</PackageProjectUrl> <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression> - <PackageReadmeFile>README.md</PackageReadmeFile> + <PackageReadmeFile>README.nuget.md</PackageReadmeFile> <PublishRepositoryUrl>true</PublishRepositoryUrl> <IncludeSymbols>true</IncludeSymbols> @@ -55,8 +55,8 @@ under the License. </PropertyGroup> <ItemGroup> - <None Include="../README.md" Pack="true" PackagePath=""> - <Link>Properties/README.md</Link> + <None Include="../README.nuget.md" Pack="true" PackagePath=""> + <Link>Properties/README.nuget.md</Link> </None> <None Include="../LICENSE" Pack="true" PackagePath=""> <Link>Properties/LICENSE</Link> diff --git a/foreign/csharp/README.nuget.md b/foreign/csharp/README.nuget.md new file mode 100644 index 000000000..d63ba3bd0 --- /dev/null +++ b/foreign/csharp/README.nuget.md @@ -0,0 +1,19 @@ + + +# Apache Iggy C# SDK + +Official C# client for [Apache Iggy](https://iggy.apache.org), a persistent message streaming platform. +Supports TCP and HTTP transports, targets .NET 8 and .NET 10. + +## Installation + +```bash +dotnet add package Apache.Iggy +``` + +## Documentation + +- [SDK README, usage and examples](https://github.com/apache/iggy/tree/master/foreign/csharp) +- [Iggy documentation](https://iggy.apache.org/docs/) +- [Issues](https://github.com/apache/iggy/issues) +- [Discord](https://discord.gg/apache-iggy)
