Add package readme, API docs

Author: kzu

src/GrokClient/Extensions.cs

@@ -6,23 +6,29 @@
 
 namespace Devlooped.Grok;
 
+/// <summary>
+/// Usability extensions for Grok gRPC clients.
+/// </summary>
 [EditorBrowsable(EditorBrowsableState.Never)]
 public static class GrpcExtensions
 {
     extension(Models.ModelsClient client)
     {
+        /// <summary>Lists available language models.</summary>
         public async Task<IEnumerable<LanguageModel>> ListLanguageModelsAsync(CancellationToken cancellation = default)
         {
             var models = await client.ListLanguageModelsAsync(new Empty(), cancellationToken: cancellation);
             return models.Models;
         }
 
+        /// <summary>Lists available embedding models.</summary>
         public async Task<IEnumerable<EmbeddingModel>> ListEmbeddingModelsAsync(CancellationToken cancellation)
         {
             var models = await client.ListEmbeddingModelsAsync(new Empty(), cancellationToken: cancellation);
             return models.Models;
         }
 
+        /// <summary>Lists available image generation models.</summary>
         public async Task<IEnumerable<ImageGenerationModel>> ListImageGenerationModelsAsync(CancellationToken cancellation = default)
         {
             var models = await client.ListImageGenerationModelsAsync(new Empty(), cancellationToken: cancellation);

src/GrokClient/GrokClient.csproj

@@ -6,6 +6,7 @@
     <AssemblyName>Devlooped.Grok</AssemblyName>
     <PackageId>GrokClient</PackageId>
     <Description>Grok gRPC client based on the official protocol buffers from xAI.</Description>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

src/GrokClient/GrokServiceCollectionExtensions.cs

@@ -1,13 +1,16 @@
-using System;
-using System.Net.Http;
-using System.Threading.Tasks;
+using System.ComponentModel;
+using Devlooped.Grok;
 using Grpc.Net.ClientFactory;
-using Microsoft.Extensions.DependencyInjection;
 
-namespace Devlooped.Grok;
+namespace Microsoft.Extensions.DependencyInjection;
 
+/// <summary>Registration extensions for Grok gRPC clients.</summary>
+[EditorBrowsable(EditorBrowsableState.Never)]
 public static class GrokServiceCollectionExtensions
 {
+    /// <summary>
+    /// Registers Grok gRPC clients with the specified API key.
+    /// </summary>
     public static IServiceCollection AddGrokClient(this IServiceCollection services, string apiKey,
         Action<GrpcClientFactoryOptions>? configureClient = null,
         Action<IHttpClientBuilder>? configureHttp = null)

src/GrokClient/readme.md

@@ -0,0 +1,10 @@
+[![EULA](https://img.shields.io/badge/EULA-OSMF-blue?labelColor=black&color=C9FF30)](osmfeula.txt)
+[![OSS](https://img.shields.io/github/license/devlooped/oss.svg?color=blue)](license.txt) 
+[![GitHub](https://img.shields.io/badge/-source-181717.svg?logo=GitHub)](https://github.com/devlooped/GrokClient)
+
+A full XAI/Grok client based on the official full gRPC API.
+
+<!-- include https://github.com/devlooped/.github/raw/main/osmf.md -->
+<!-- include ../../readme.md#content -->
+<!-- include https://github.com/devlooped/sponsors/raw/main/footer.md -->
+<!-- exclude -->