From 4780cf861970d2c27d5c2ac092616120b010b325 Mon Sep 17 00:00:00 2001
From: Ziya Suzen <ziya@suzen.net>
Date: Sat, 2 Nov 2024 21:51:58 +0000
Subject: [PATCH] Add docs to the client

---
 src/NATS.Client.Simplified/NatsClient.cs | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)

diff --git a/src/NATS.Client.Simplified/NatsClient.cs b/src/NATS.Client.Simplified/NatsClient.cs
index 87de0d6c0..5cc9dc383 100644
--- a/src/NATS.Client.Simplified/NatsClient.cs
+++ b/src/NATS.Client.Simplified/NatsClient.cs
@@ -11,9 +11,25 @@ public class NatsClient : INatsClient
     /// <summary>
     /// Initializes a new instance of the <see cref="NatsClient"/> class.
     /// </summary>
-    /// <param name="url">NATS server URL</param>
-    /// <param name="name">Client name</param>
-    /// <param name="credsFile">Credentials filepath</param>
+    /// <param name="url">NATS server URL to connect to. (default: nats://localhost:4222)</param>
+    /// <param name="name">Client name. (default: NATS .NET Client)</param>
+    /// <param name="credsFile">Credentials filepath.</param>
+    /// <remarks>
+    /// <para>
+    /// You can set more than one server as seed servers in a comma-separated list in the <paramref name="url"/>.
+    /// The client will randomly select a server from the list to connect.
+    /// </para>
+    /// <para>
+    /// User-password or token authentication can be set in the <paramref name="url"/>.
+    /// For example, <c>nats://derek:s3cr3t@localhost:4222</c> or <c>nats://token@localhost:4222</c>.
+    /// You should URL-encode the username and password or token if they contain special characters.
+    /// </para>
+    /// <para>
+    /// If multiple servers are specified and user-password or token authentication is used in the <paramref name="url"/>,
+    /// only the credentials in the first server URL will be used; credentials in the remaining server
+    /// URLs will be ignored.
+    /// </para>
+    /// </remarks>
     public NatsClient(
         string url = "nats://localhost:4222",
         string name = "NATS .NET Client",