Add package README for Orleans.Streaming.NATS

[Copilot]

• Examine existing streaming package READMEs to understand structure and style
• Review Orleans.Streaming.NATS package code and configuration options
• Create README.md following the established pattern with:
  • Introduction section
  • Getting Started with NuGet installation
  • Configuration example for silo
  • Configuration example for client
  • Stream producer/consumer example
  • Documentation links
  • Feedback & Contributing section
• Request code review
• Address code review feedback (removed unnecessary named parameter)
• Update csproj to include README.md in NuGet package

Original prompt

On Orleans.Streaming.NATS, Create a package readme for the Orleans.Streaming.NATS package. Look at the other packages to see how their READMEs are typically structured.

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Microsoft Reviewers: Open in CodeFlow

[ReubenBond]

@copilot Do we need to change the csproj so that it includes this README in the nuget package?

[Copilot]

@copilot Do we need to change the csproj so that it includes this README in the nuget package?

Yes, updated in commit e2fecce. Added <PackageReadmeFile>README.md</PackageReadmeFile> to the PropertyGroup and <None Include="README.md" Pack="true" PackagePath="\" /> to include it in the NuGet package, following the same pattern as other Orleans packages.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

• 0t3vsblobprodcus362.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Streaming.NATS/Orleans.Streaming.NATS.csproj --no-incremental (dns block)
• 96bvsblobprodcus338.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Streaming.NATS/Orleans.Streaming.NATS.csproj --no-incremental (dns block)
• cflvsblobprodcus383.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Streaming.NATS/Orleans.Streaming.NATS.csproj --no-incremental (dns block)
• ckzvsblobprodcus347.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Streaming.NATS/Orleans.Streaming.NATS.csproj --no-incremental (dns block)
• dnceng.pkgs.visualstudio.com
  • Triggering command: dotnet build src/Orleans.Streaming.NATS/Orleans.Streaming.NATS.csproj --no-incremental (dns block)
• frdvsblobprodcus327.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Streaming.NATS/Orleans.Streaming.NATS.csproj --no-incremental (dns block)
• imzvsblobprodcus368.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Streaming.NATS/Orleans.Streaming.NATS.csproj --no-incremental (dns block)
• jrqvsblobprodcus343.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Streaming.NATS/Orleans.Streaming.NATS.csproj --no-incremental (dns block)
• kh4vsblobprodcus325.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Streaming.NATS/Orleans.Streaming.NATS.csproj --no-incremental (dns block)
• lylvsblobprodcus31.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Streaming.NATS/Orleans.Streaming.NATS.csproj --no-incremental (dns block)
• m6xvsblobprodcus342.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Streaming.NATS/Orleans.Streaming.NATS.csproj --no-incremental (dns block)
• pdfvsblobprodcus380.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Streaming.NATS/Orleans.Streaming.NATS.csproj --no-incremental (dns block)
• rcxvsblobprodcus328.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Streaming.NATS/Orleans.Streaming.NATS.csproj --no-incremental (dns block)
• yluvsblobprodcus367.vsblob.vsassets.io
  • Triggering command: dotnet build src/Orleans.Streaming.NATS/Orleans.Streaming.NATS.csproj --no-incremental (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

• Configure Actions setup steps to set up my environment, which run before the firewall is enabled
• Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)