From 5c9c8cef78ad05e1802879d54a49d6230442209b Mon Sep 17 00:00:00 2001
From: adams85 <31276480+adams85@users.noreply.github.com>
Date: Thu, 1 Jun 2023 14:10:29 +0200
Subject: [PATCH] Update docs & samples (#70)

* Update readme & samples

* Add warning about type matching to the XML documentation of generic evaluation methods
---
 README.md                                     |  1 -
 .../WebApplication/WebApplication.csproj      |  2 +-
 samples/ConsoleApp/ConsoleApp.csproj          |  2 +-
 src/ConfigCatClient/IConfigCatClient.cs       | 20 +++++++++++++++++++
 4 files changed, 22 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 7ce85b4f..a335c8df 100644
--- a/README.md
+++ b/README.md
@@ -43,7 +43,6 @@ using ConfigCat.Client;
 var client = ConfigCatClient.Get("#YOUR-SDK-KEY#");
 ```
 
-> We strongly recommend using the *ConfigCat Client* as a Singleton object in your application.
 > You can acquire singleton client instances for your SDK keys using the `ConfigCatClient.Get(sdkKey: <sdkKey>)` static factory method.
 (However, please keep in mind that subsequent calls to `ConfigCatClient.Get()` with the *same SDK Key* return a *shared* client instance, which was set up by the first call.)
 
diff --git a/samples/ASP.NETCore/WebApplication/WebApplication.csproj b/samples/ASP.NETCore/WebApplication/WebApplication.csproj
index 00523d7c..b0c81d2a 100644
--- a/samples/ASP.NETCore/WebApplication/WebApplication.csproj
+++ b/samples/ASP.NETCore/WebApplication/WebApplication.csproj
@@ -8,7 +8,7 @@
   <ItemGroup>
     <ProjectReference Include="..\..\..\src\ConfigCatClient\ConfigCatClient.csproj" />
     <!-- Use PackageReference instead of the ProjectReference above in your application. -->
-    <!--<PackageReference Include="ConfigCat.Client" Version="7.0.0" />-->    
+    <!--<PackageReference Include="ConfigCat.Client" Version="8.0.0" />-->    
     <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="6.0.*" />
     <PackageReference Include="Microsoft.Web.LibraryManager.Build" Version="2.1.175" />
   </ItemGroup>
diff --git a/samples/ConsoleApp/ConsoleApp.csproj b/samples/ConsoleApp/ConsoleApp.csproj
index 212ad322..6c148f16 100644
--- a/samples/ConsoleApp/ConsoleApp.csproj
+++ b/samples/ConsoleApp/ConsoleApp.csproj
@@ -9,7 +9,7 @@
   <ItemGroup>
     <ProjectReference Include="..\..\src\ConfigCatClient\ConfigCatClient.csproj" />  
     <!-- Use PackageReference instead of the ProjectReference above in your application. -->
-    <!--<PackageReference Include="ConfigCat.Client" Version="7.0.0" />-->
+    <!--<PackageReference Include="ConfigCat.Client" Version="8.0.0" />-->
   </ItemGroup>
 
 </Project>
diff --git a/src/ConfigCatClient/IConfigCatClient.cs b/src/ConfigCatClient/IConfigCatClient.cs
index 385993ac..47468aa1 100644
--- a/src/ConfigCatClient/IConfigCatClient.cs
+++ b/src/ConfigCatClient/IConfigCatClient.cs
@@ -18,6 +18,11 @@ public interface IConfigCatClient : IProvidesHooks, IDisposable
     /// <summary>
     /// Returns the value of a feature flag or setting identified by <paramref name="key"/> synchronously.
     /// </summary>
+    /// <remarks>
+    /// It is important to provide an argument for the <paramref name="defaultValue"/> parameter, specifically for the <typeparamref name="T"/> generic type parameter,
+    /// that matches the type of the feature flag or setting you are evaluating.<br/>
+    /// Please refer to <see href="https://configcat.com/docs/sdk-reference/dotnet/#setting-type-mapping">this table</see> for the corresponding types.
+    /// </remarks>
     /// <typeparam name="T">
     /// The type of the value. Only the following types are allowed:
     /// <see cref="string"/>, <see cref="bool"/>, <see cref="int"/>, <see cref="long"/>, <see cref="double"/> and <see cref="object"/> (both nullable and non-nullable).<br/>
@@ -35,6 +40,11 @@ public interface IConfigCatClient : IProvidesHooks, IDisposable
     /// <summary>
     /// Returns the value of a feature flag or setting identified by <paramref name="key"/> asynchronously.
     /// </summary>
+    /// <remarks>
+    /// It is important to provide an argument for the <paramref name="defaultValue"/> parameter, specifically for the <typeparamref name="T"/> generic type parameter,
+    /// that matches the type of the feature flag or setting you are evaluating.<br/>
+    /// Please refer to <see href="https://configcat.com/docs/sdk-reference/dotnet/#setting-type-mapping">this table</see> for the corresponding types.
+    /// </remarks>
     /// <typeparam name="T">
     /// The type of the value. Only the following types are allowed:
     /// <see cref="string"/>, <see cref="bool"/>, <see cref="int"/>, <see cref="long"/>, <see cref="double"/> and <see cref="object"/> (both nullable and non-nullable).<br/>
@@ -54,6 +64,11 @@ public interface IConfigCatClient : IProvidesHooks, IDisposable
     /// <summary>
     /// Returns the value along with evaluation details of a feature flag or setting identified by <paramref name="key"/> synchronously.
     /// </summary>
+    /// <remarks>
+    /// It is important to provide an argument for the <paramref name="defaultValue"/> parameter, specifically for the <typeparamref name="T"/> generic type parameter,
+    /// that matches the type of the feature flag or setting you are evaluating.<br/>
+    /// Please refer to <see href="https://configcat.com/docs/sdk-reference/dotnet/#setting-type-mapping">this table</see> for the corresponding types.
+    /// </remarks>
     /// <typeparam name="T">
     /// The type of the value. Only the following types are allowed:
     /// <see cref="string"/>, <see cref="bool"/>, <see cref="int"/>, <see cref="long"/>, <see cref="double"/> and <see cref="object"/> (both nullable and non-nullable).<br/>
@@ -71,6 +86,11 @@ public interface IConfigCatClient : IProvidesHooks, IDisposable
     /// <summary>
     /// Returns the value along with evaluation details of a feature flag or setting identified by <paramref name="key"/> asynchronously.
     /// </summary>
+    /// <remarks>
+    /// It is important to provide an argument for the <paramref name="defaultValue"/> parameter, specifically for the <typeparamref name="T"/> generic type parameter,
+    /// that matches the type of the feature flag or setting you are evaluating.<br/>
+    /// Please refer to <see href="https://configcat.com/docs/sdk-reference/dotnet/#setting-type-mapping">this table</see> for the corresponding types.
+    /// </remarks>
     /// <typeparam name="T">
     /// The type of the value. Only the following types are allowed:
     /// <see cref="string"/>, <see cref="bool"/>, <see cref="int"/>, <see cref="long"/>, <see cref="double"/> and <see cref="object"/> (both nullable and non-nullable).<br/>