Add README files for core projects and include them in NuGet packages

[snovak7]

Closes #263

Summary by Sourcery

Document hosting extensions packages and update root README for NuGet distribution

Documentation:

• Add detailed root README describing features, tech stack, usage, and scripts for hosting extensions.
• Add package-specific READMEs for Orleans, Temporalio, ServiceDefaults, and UserSecrets projects with features, usage, and configuration details.
• Ensure project READMEs are included in their respective NuGet packages.

[sourcery-ai]

Reviewer's Guide

Adds detailed top-level documentation and project-specific READMEs for each core hosting extension (Orleans, Temporalio, ServiceDefaults, UserSecrets), introduces repository-level metadata (badges, tech stack, usage, scripts, env vars, licensing), and ensures these docs are available in NuGet packages via project file updates and a root LICENSE file.

File-Level Changes

Change	Details	Files
Rewrite the root README to describe the full repository, tech stack, usage, scripts, environment variables, and licensing, with badges and examples.	Replace the previous package-focused README with a repository-wide overview including badges, key features, tech stack, project structure, and getting-started sections. Add installation instructions and a minimal usage example demonstrating AddServiceDefaults in Program.cs. Document common build/test/pack scripts and important environment variables like OTEL_EXPORTER_OTLP_ENDPOINT and ASPNETCORE_ENVIRONMENT. Add an explicit License section referencing the new LICENSE file.	README.md
Add package-specific README documentation for Temporalio hosting extensions, covering features, usage, and configuration.	Describe Temporalio hosting extensions, including HostApplicationBuilder extensions and OpenTelemetry integration. Provide basic code samples for adding Temporal client and worker runtime via builder extensions. Document required and optional environment variables for Temporal configuration (TEMPORAL_GRPC, TEMPORAL_NAMESPACE, TEMPORAL_QUEUE, TEMPORAL_BUILD_ID).	src/Temporalio/README.md
Add package-specific README documentation for Orleans hosting extensions, covering features, usage, and configuration.	Introduce Orleans hosting extensions with a NuGet badge and high-level description. Document supported capabilities such as clustering, persistence, reminders, streaming, event sourcing, and telemetry integration. Provide sample code showing AddOrleansServerRuntime and AddOrleansClientRuntime usage. Describe configuration knobs like Hosting and ClusterOptions bindings.	src/Orleans/README.md
Add package-specific README documentation for ServiceDefaults hosting extensions, detailing features and usage patterns.	Describe the purpose of ServiceDefaults hosting extensions with a NuGet badge and feature overview. Explain OpenTelemetry, health checks, service discovery, and resilience defaults provided by the package. Show basic usage for AddServiceDefaults and specialized variants like AddLowLatencyServiceDefaults and AddBackendServiceDefaults. Document the OTEL_EXPORTER_OTLP_ENDPOINT configuration behavior.	src/ServiceDefaults/README.md
Add package-specific README documentation for UserSecrets hosting extensions with minimal usage guidance.	Introduce UserSecrets hosting extensions with a NuGet badge and short description. Provide a simple code example showing builder.AddUserSecrets(). Clarify that User Secrets are only added when the environment is Development.	src/UserSecrets/README.md
Add a repository-level LICENSE file to formalize Apache 2.0 licensing for the project.	Create a new LICENSE file at the repository root to be referenced by documentation and included in packages.	LICENSE

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#263	Add a README.md file for each package (Orleans, Temporalio, ServiceDefaults, UserSecrets) so that every package has its own documentation file.	✅
#263	Configure the package projects to include their README.md files in the generated NuGet packages.	✅

Possibly linked issues

• Add README.md for each package #263: The PR creates READMEs for core packages and wires them into NuGet packaging, fulfilling the issue request.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Warning

Rate limit exceeded

@snovak7 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 24 minutes and 45 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4458ea2c-4e54-45d9-bb7b-70712f0f08fb

📥 Commits

Reviewing files that changed from the base of the PR and between 0217221 and da23d3b.

📒 Files selected for processing (10)

• LICENSE
• README.md
• src/Orleans/Escendit.Extensions.Hosting.Orleans.csproj
• src/Orleans/README.md
• src/ServiceDefaults/Escendit.Extensions.Hosting.ServiceDefaults.csproj
• src/ServiceDefaults/README.md
• src/Temporalio/Escendit.Extensions.Hosting.Temporalio.csproj
• src/Temporalio/README.md
• src/UserSecrets/Escendit.Extensions.Hosting.UserSecrets.csproj
• src/UserSecrets/README.md

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch 263-add-readmemd-for-each-package

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Review rate limit: 0/1 reviews remaining, refill in 24 minutes and 45 seconds.}

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sourcery-ai]

Hey - I've left some high level feedback:

• The root README lists C# 14 and .NET 10, which don’t currently exist; consider updating these to the actual targeted C#/.NET versions to avoid confusion for consumers.
• In the root README’s Scripts & Commands section, the dotnet test (TODO: Add tests to the project) note mixes instructions with TODOs; consider either removing the TODO or moving it to an issue/roadmap section to keep the README focused on usable commands.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The root README lists C# 14 and .NET 10, which don’t currently exist; consider updating these to the actual targeted C#/.NET versions to avoid confusion for consumers.
- In the root README’s Scripts & Commands section, the `dotnet test (TODO: Add tests to the project)` note mixes instructions with TODOs; consider either removing the TODO or moving it to an issue/roadmap section to keep the README focused on usable commands.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}