Add READMEs to NuGet packages

src/AWS/Orleans.Clustering.DynamoDB/Orleans.Clustering.DynamoDB.csproj

@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageId>Microsoft.Orleans.Clustering.DynamoDB</PackageId>
     <Title>Microsoft Orleans AWS DynamoDB Clustering Provider</Title>
     <Description>Microsoft Orleans clustering provider backed by AWS DynamoDB</Description>
@@ -24,4 +25,8 @@
     <PackageReference Include="AWSSDK.DynamoDBv2" />
   </ItemGroup>
 
+
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
 </Project>

src/AWS/Orleans.Clustering.DynamoDB/README.md

@@ -0,0 +1,80 @@
+# Microsoft Orleans Clustering for DynamoDB
+
+## Introduction
+Microsoft Orleans Clustering for DynamoDB provides cluster membership functionality for Microsoft Orleans using Amazon's DynamoDB. This allows Orleans silos to coordinate and form a cluster using DynamoDB as the backing store.
+
+## Getting Started
+To use this package, install it via NuGet:
+
+```shell
+dotnet add package Microsoft.Orleans.Clustering.DynamoDB
+```
+
+## Example - Configuring DynamoDB Membership
+```csharp
+using Microsoft.Extensions.Hosting;
+using Orleans.Hosting;
+using Microsoft.Extensions.DependencyInjection;
+using System;
+using System.Threading.Tasks;
+
+namespace ExampleGrains;
+
+// Define a grain interface
+public interface IHelloGrain : IGrainWithStringKey
+{
+    Task<string> SayHello(string greeting);
+}
+
+// Implement the grain interface
+public class HelloGrain : Grain, IHelloGrain
+{
+    public Task<string> SayHello(string greeting)
+    {
+        return Task.FromResult($"Hello, {greeting}!");
+    }
+}
+
+var builder = Host.CreateApplicationBuilder(args)
+    .UseOrleans(siloBuilder =>
+    {
+        siloBuilder
+            // Configure DynamoDB clustering
+            .UseDynamoDBClustering(options =>
+            {
+                options.AccessKey = "YOUR_AWS_ACCESS_KEY";
+                options.SecretKey = "YOUR_AWS_SECRET_KEY";
+                options.Region = "us-east-1";
+                options.TableName = "OrleansClusteringTable";
+                options.CreateIfNotExists = true;
+            });
+    });
+
+var host = builder.Build();
+await host.StartAsync();
+
+// Get a reference to a grain and call it
+var client = host.Services.GetRequiredService<IClusterClient>();
+var grain = client.GetGrain<IHelloGrain>("user123");
+var response = await grain.SayHello("DynamoDB");
+
+// Print the result
+Console.WriteLine($"Grain response: {response}");
+
+// Keep the host running until the application is shut down
+await host.WaitForShutdownAsync();
+```
+
+## Documentation
+For more comprehensive documentation, please refer to:
+- [Microsoft Orleans Documentation](https://learn.microsoft.com/dotnet/orleans/)
+- [Configuration Guide](https://learn.microsoft.com/en-us/dotnet/orleans/host/configuration-guide/)
+- [Orleans Clustering](https://learn.microsoft.com/en-us/dotnet/orleans/implementation/cluster-management)
+- [AWS SDK for .NET Documentation](https://docs.aws.amazon.com/sdk-for-net/index.html)
+
+## Feedback & Contributing
+- If you have any issues or would like to provide feedback, please [open an issue on GitHub](https://github.com/dotnet/orleans/issues)
+- Join our community on [Discord](https://aka.ms/orleans-discord)
+- Follow the [@msftorleans](https://twitter.com/msftorleans) Twitter account for Orleans announcements
+- Contributions are welcome! Please review our [contribution guidelines](https://github.com/dotnet/orleans/blob/main/CONTRIBUTING.md)
+- This project is licensed under the [MIT license](https://github.com/dotnet/orleans/blob/main/LICENSE)

src/AWS/Orleans.Persistence.DynamoDB/Orleans.Persistence.DynamoDB.csproj

@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageId>Microsoft.Orleans.Persistence.DynamoDB</PackageId>
     <Title>Microsoft Orleans AWS DynamoDB Persistence Provider</Title>
     <Description>Microsoft Orleans persistence providers backed by AWS DynamoDB</Description>
@@ -23,4 +24,8 @@
     <ProjectReference Include="$(SourceRoot)src\Orleans.Runtime\Orleans.Runtime.csproj" />
     <PackageReference Include="AWSSDK.DynamoDBv2" />
   </ItemGroup>
+
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
 </Project>

src/AWS/Orleans.Persistence.DynamoDB/README.md

@@ -0,0 +1,86 @@
+# Microsoft Orleans Persistence for DynamoDB
+
+## Introduction
+Microsoft Orleans Persistence for DynamoDB provides grain persistence for Microsoft Orleans using Amazon's DynamoDB. This allows your grains to persist their state in DynamoDB and reload it when they are reactivated.
+
+## Getting Started
+To use this package, install it via NuGet:
+
+```shell
+dotnet add package Microsoft.Orleans.Persistence.DynamoDB
+```
+
+## Example - Configuring DynamoDB Persistence
+```csharp
+using Microsoft.Extensions.Hosting;
+using Orleans.Configuration;
+using Orleans.Hosting;
+
+var builder = Host.CreateApplicationBuilder(args)
+    .UseOrleans(siloBuilder =>
+    {
+        siloBuilder
+            .UseLocalhostClustering()
+            // Configure DynamoDB as grain storage
+            .AddDynamoDBGrainStorage(
+                name: "dynamoStore",
+                configureOptions: options =>
+                {
+                    options.AccessKey = "YOUR_AWS_ACCESS_KEY";
+                    options.SecretKey = "YOUR_AWS_SECRET_KEY";
+                    options.Region = "us-east-1";
+                    options.TableName = "OrleansGrainState";
+                    options.CreateIfNotExists = true;
+                });
+    });
+
+// Run the host
+await builder.RunAsync();
+```
+
+## Example - Using Grain Storage in a Grain
+```csharp
+// Define grain state class
+
+public class MyGrainState
+{
+    public string Data { get; set; }
+    public int Version { get; set; }
+}
+
+// Grain implementation that uses the DynamoDB storage
+public class MyGrain : Grain, IMyGrain, IGrainWithStringKey
+{
+    private readonly IPersistentState<MyGrainState> _state;
+
+    public MyGrain([PersistentState("state", "dynamoStore")] IPersistentState<MyGrainState> state)
+    {
+        _state = state;
+    }
+
+    public async Task SetData(string data)
+    {
+        _state.State.Data = data;
+        _state.State.Version++;
+        await _state.WriteStateAsync();
+    }
+
+    public Task<string> GetData()
+    {
+        return Task.FromResult(_state.State.Data);
+    }
+}
+```
+
+## Documentation
+For more comprehensive documentation, please refer to:
+- [Microsoft Orleans Documentation](https://learn.microsoft.com/dotnet/orleans/)
+- [Grain Persistence](https://learn.microsoft.com/en-us/dotnet/orleans/grains/grain-persistence)
+- [AWS SDK for .NET Documentation](https://docs.aws.amazon.com/sdk-for-net/index.html)
+
+## Feedback & Contributing
+- If you have any issues or would like to provide feedback, please [open an issue on GitHub](https://github.com/dotnet/orleans/issues)
+- Join our community on [Discord](https://aka.ms/orleans-discord)
+- Follow the [@msftorleans](https://twitter.com/msftorleans) Twitter account for Orleans announcements
+- Contributions are welcome! Please review our [contribution guidelines](https://github.com/dotnet/orleans/blob/main/CONTRIBUTING.md)
+- This project is licensed under the [MIT license](https://github.com/dotnet/orleans/blob/main/LICENSE)

src/AWS/Orleans.Reminders.DynamoDB/Orleans.Reminders.DynamoDB.csproj

@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageId>Microsoft.Orleans.Reminders.DynamoDB</PackageId>
     <Title>Microsoft Orleans AWS DynamoDB Reminders Provider</Title>
     <Description>Microsoft Orleans reminders provider backed by AWS DynamoDB</Description>
@@ -26,4 +27,8 @@
     <PackageReference Include="AWSSDK.DynamoDBv2" />
   </ItemGroup>
 
+
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
 </Project>

src/AWS/Orleans.Reminders.DynamoDB/README.md

@@ -0,0 +1,113 @@
+# Microsoft Orleans Reminders for DynamoDB
+
+## Introduction
+Microsoft Orleans Reminders for DynamoDB provides persistence for Orleans reminders using Amazon's DynamoDB. This allows your Orleans applications to schedule persistent reminders that will be triggered even after silo restarts or grain deactivation.
+
+## Getting Started
+To use this package, install it via NuGet:
+
+```shell
+dotnet add package Microsoft.Orleans.Reminders.DynamoDB
+```
+
+## Example - Configuring DynamoDB Reminders
+```csharp
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.DependencyInjection;
+using Orleans.Configuration;
+using Orleans.Hosting;
+
+var builder = Host.CreateApplicationBuilder(args)
+    .UseOrleans(siloBuilder =>
+    {
+        siloBuilder
+            .UseLocalhostClustering()
+            // Configure DynamoDB as reminder storage
+            .UseDynamoDBReminderService(options =>
+            {
+                options.AccessKey = "YOUR_AWS_ACCESS_KEY";
+                options.SecretKey = "YOUR_AWS_SECRET_KEY";
+                options.Region = "us-east-1";
+                options.TableName = "OrleansReminders";
+                options.CreateIfNotExists = true;
+            });
+    });
+
+// Run the host
+var host = builder.Build();
+await host.StartAsync();
+
+// Get a reference to the grain
+var reminderGrain = host.Services.GetRequiredService<IGrainFactory>()
+    .GetGrain<IReminderGrain>("my-reminder-grain");
+
+// Start the reminder
+await reminderGrain.StartReminder("ExampleReminder");
+Console.WriteLine("Reminder started!");
+
+// Keep the host running until the application is shut down
+await host.WaitForShutdownAsync();
+```
+
+## Example - Using Reminders in a Grain
+```csharp
+using System;
+using System.Threading.Tasks;
+using Orleans;
+using Orleans.Runtime;
+
+namespace ReminderExample;
+
+public interface IReminderGrain : IGrainWithStringKey
+{
+    Task StartReminder(string reminderName);
+    Task StopReminder();
+}
+
+public class ReminderGrain : Grain, IReminderGrain, IRemindable
+{
+    private string _reminderName = "MyReminder";
+
+    public async Task StartReminder(string reminderName)
+    {
+        _reminderName = reminderName;
+
+        // Register a persistent reminder
+        await RegisterOrUpdateReminder(
+            reminderName,
+            TimeSpan.FromMinutes(2),  // Time to delay before the first tick (must be > 1 minute)
+            TimeSpan.FromMinutes(5)); // Period of the reminder (must be > 1 minute)
+    }
+
+    public async Task StopReminder()
+    {
+        // Find and unregister the reminder
+        var reminder = await GetReminder(_reminderName);
+        if (reminder != null)
+        {
+            await UnregisterReminder(reminder);
+        }
+    }
+
+    public Task ReceiveReminder(string reminderName, TickStatus status)
+    {
+        // This method is called when the reminder ticks
+        Console.WriteLine($"Reminder {reminderName} triggered at {DateTime.UtcNow}. Status: {status}");
+        return Task.CompletedTask;
+    }
+}
+```
+
+## Documentation
+For more comprehensive documentation, please refer to:
+- [Microsoft Orleans Documentation](https://learn.microsoft.com/dotnet/orleans/)
+- [Reminders and Timers](https://learn.microsoft.com/en-us/dotnet/orleans/grains/timers-and-reminders)
+- [Reminder Services](https://learn.microsoft.com/en-us/dotnet/orleans/implementation/reminder-services)
+- [AWS SDK for .NET Documentation](https://docs.aws.amazon.com/sdk-for-net/index.html)
+
+## Feedback & Contributing
+- If you have any issues or would like to provide feedback, please [open an issue on GitHub](https://github.com/dotnet/orleans/issues)
+- Join our community on [Discord](https://aka.ms/orleans-discord)
+- Follow the [@msftorleans](https://twitter.com/msftorleans) Twitter account for Orleans announcements
+- Contributions are welcome! Please review our [contribution guidelines](https://github.com/dotnet/orleans/blob/main/CONTRIBUTING.md)
+- This project is licensed under the [MIT license](https://github.com/dotnet/orleans/blob/main/LICENSE)

src/AWS/Orleans.Streaming.SQS/Orleans.Streaming.SQS.csproj

@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageId>Microsoft.Orleans.Streaming.SQS</PackageId>
     <Title>Microsoft Orleans AWS SQS Streaming Provider</Title>
     <Description>Microsoft Orleans streaming provider backed by AWS SQS</Description>
@@ -18,4 +19,8 @@
     <PackageReference Include="AWSSDK.SQS" />
   </ItemGroup>
 
+
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
 </Project>