Documentation draft

Author: Harold-Morgan

CODEOWNERS

@@ -102,4 +102,14 @@
 # CommunityToolkit.Aspire.Hosting.SqlServer.Extensions
 /src/CommunityToolkit.Aspire.Hosting.SqlServer.Extensions/ @Alirexaa
 /tests/CommunityToolkit.Aspire.Hosting.SqlServer.Extensions.Tests/ @Alirexaa
-/examples/sqlserver-ext/ @Alirexaa
+/examples/sqlserver-ext/ @Alirexaa
+
+# CommunityToolkit.Aspire.Minio.Client
+# CommunityToolkit.Aspire.Hosting.Minio
+
+/examples/minio/ @Harold-Morgan
+/src/CommunityToolkit.Aspire.Hosting.Minio/ @Harold-Morgan
+/tests/CommunityToolkit.Aspire.Hosting.Minio.Tests/ @Harold-Morgan
+
+/src/CommunityToolkit.Aspire.Minio.Client/ @Harold-Morgan
+/tests/CommunityToolkit.Aspire.Minio.Client.Tests/ @Harold-Morgan

src/CommunityToolkit.Aspire.Hosting.Minio/README.md

@@ -0,0 +1,37 @@
+# CommunityToolkit.Aspire.Hosting.MinoO library
+
+Provides extension methods and resource definitions for the .NET Aspire AppHost to support running [MiniO](https://min.io/) containers.
+
+## Getting Started
+
+### Install the package
+
+In your AppHost project, install the package using the following command:
+
+```dotnetcli
+dotnet add package CommunityToolkit.Aspire.Hosting.Minio
+```
+
+### Example usage
+
+Then, in the _Program.cs_ file of `AppHost`, add a Minio resource and consume the connection using the following methods:
+
+```csharp
+var builder = DistributedApplication.CreateBuilder(args);
+
+var minio = builder.AddMinio("minio");
+
+var myService = builder.AddProject<Projects.MyService>()
+                       .WithReference(minio);
+
+builder.Build().Run();
+```
+
+## Additional Information
+
+https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-minio
+
+## Feedback & contributing
+
+https://github.com/CommunityToolkit/Aspire
+

src/CommunityToolkit.Aspire.Minio.Client/README.md

@@ -10,7 +10,7 @@ Registers a [MiniOClient](https://github.com/minio/minio-dotnet) in the DI conta
 
 ### Install the package
 
-Install the .NET Aspire Minio Client library with [NuGet](https://www.nuget.org):
+Install the .NET Aspire MiniO Client library with [NuGet](https://www.nuget.org):
 
 ```dotnetcli
 dotnet add package CommunityToolkit.Aspire.Minio.Client
@@ -26,37 +26,41 @@ builder.AddMinioClient();
 
 ## Configuration
 
-The .NET Aspire Minio Client integration provides multiple options to configure the server connection based on the requirements and conventions of your project.
+The .NET Aspire MiniO Client integration provides multiple options to configure the server connection based on the requirements and conventions of your project.
 
 ### Use a connection string
 
 When using a connection string from the `ConnectionStrings` configuration section, you can provide the name of the connection string when calling `builder.AddMinioClient()`:
 
 ```csharp
-builder.AddMeilisearchClient("minio");
+builder.AddMinioClient("minio");
 ```
 
 And then the connection string will be retrieved from the `ConnectionStrings` configuration section:
 
 ```json
 {
     "ConnectionStrings": {
-        "minio": "Endpoint=http://localhost:19530/;MasterKey=123456!@#$%"
+        "minio": "Endpoint=http://localhost:9001/;AccessKey=minioAdmin;SecretKey=minioAdmin"
     }
 }
 ```
 
 ### Use configuration providers
 
-The .NET Aspire Meilisearch Client integration supports [Microsoft.Extensions.Configuration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration). It loads the `MeilisearchClientSettings` from configuration by using the `Aspire:Meilisearch:Client` key. Example `appsettings.json` that configures some of the options:
+The .NET Aspire MiniO Client integration supports [Microsoft.Extensions.Configuration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration).
+It loads the `MinioClientSettings` from configuration by using the `Aspire:Minio:Client` key.
+This key can be overriden by using the `configurationSectionName` method parameter.
+Example `appsettings.json` that configures some of the options:
 
 ```json
 {
   "Aspire": {
-    "Meilisearch": {
+    "Minio": {
       "Client": {
-        "Endpoint": "http://localhost:19530/",
-        "MasterKey": "123456!@#$%"
+        "Endpoint": "http://localhost:9001/",
+        "AccessKey": "minioAdmin",
+        "SecretKey": "minioAdmin"
       }
     }
   }
@@ -65,10 +69,10 @@ The .NET Aspire Meilisearch Client integration supports [Microsoft.Extensions.Co
 
 ### Use inline delegates
 
-Also you can pass the `Action<MeilisearchClientSettings> configureSettings` delegate to set up some or all the options inline, for example to set the API key from code:
+Also you can pass the `Action<MinioClientSettings> configureSettings` delegate to set up some or all the options inline, for example to set the API key from code:
 
 ```csharp
-builder.AddMeilisearchClient("meilisearch", settings => settings.MasterKey = "123456!@#$%");
+builder.AddMinioClient("minio", configureSettings: settings => settings.SecretKey = "minioAdmin");
 ```
 
 ## AppHost extensions
@@ -88,16 +92,17 @@ var myService = builder.AddProject<Projects.MyService>()
                        .WithReference(minio);
 ```
 
-The `WithReference` method configures a connection in the `MyService` project named `minio`. In the _Program.cs_ file of `MyService`, the Minio connection can be consumed using:
+The `WithReference` method configures a connection in the `MyService` project named `minio`.
+In the _Program.cs_ file of `MyService`, the MiniO connection can be consumed using:
 
 ```csharp
 builder.AddMinioClient("minio");
 ```
 
-Then, in your service, inject `MeilisearchClient` and use it to interact with the Meilisearch API:
+Then, in your service, inject `IMinioClient` and use it to interact with the MiniO or other S3 compatible API:
 
 ```csharp
-public class MyService(MeilisearchClient meilisearchClient)
+public class MyService(IMinioClient minioClient)
 {
     // ...
 }