From 85bb5fedbf6ad5c8a989ec98a586d864d6249e5b Mon Sep 17 00:00:00 2001 From: Adam Simon Date: Sat, 27 Jul 2024 22:54:11 +0200 Subject: [PATCH] Update README.md --- README.md | 16 +++++++++++----- samples/ASP.NETCore/README.md | 2 +- samples/BlazorWasm/README.md | 2 +- samples/ConsoleApp/README.md | 6 +++--- samples/UnityWebGL/README.md | 2 +- 5 files changed, 17 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a335c8df..0795327d 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,11 @@ - .NET Framework 4.5+ - Other runtimes which implement .NET Standard 2.0+ like .NET Core 2.0+, Xamarin.Android 8.0+, Xamarin.iOS 10.14+, etc. (For more details, please refer to [this table](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0).) -https://configcat.com +Starting with v9.3.0, the ConfigCat SDK can be used in applications that employ [trimmed self-contained](https://learn.microsoft.com/en-us/dotnet/core/deploying/trimming/trim-self-contained) or various ahead-of-time (AOT) compilation deployment models. +The SDK has been tested with the following AOT solutions: +* [Native AOT](https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot/) - see also [Sample .NET Console app](https://github.com/configcat/.net-sdk/tree/master/samples/ConsoleApp) +* [Mono WebAssembly AOT/Emscripten (wasm-tools)](https://learn.microsoft.com/en-us/aspnet/core/blazor/webassembly-build-tools-and-aot?view=aspnetcore-8.0) - see also [Sample ASP.NET Core Blazor WebAssembly app](https://github.com/configcat/.net-sdk/tree/master/samples/BlazorWasm) +* [IL2CPP](https://docs.unity3d.com/2021.3/Documentation/Manual/IL2CPP.html) - see also [Sample Unity WebGL scripts](https://github.com/configcat/.net-sdk/tree/master/samples/UnityWebGL) ConfigCat SDK for .NET provides easy integration for your application to ConfigCat. @@ -48,7 +52,7 @@ var client = ConfigCatClient.Get("#YOUR-SDK-KEY#"); ### 5. Get your setting value: ```c# -var isMyAwesomeFeatureEnabled = client.GetValue("isMyAwesomeFeatureEnabled", false); +var isMyAwesomeFeatureEnabled = await client.GetValueAsync("isMyAwesomeFeatureEnabled", false); if(isMyAwesomeFeatureEnabled) { @@ -74,7 +78,7 @@ Read more about [Targeting here](https://configcat.com/docs/advanced/targeting). ```c# User currentUser = new User("435170f4-8a8b-4b67-a723-505ac7cdea92"); -var isMyAwesomeFeatureEnabled = client.GetValue( +var isMyAwesomeFeatureEnabled = await client.GetValueAsync( "isMyAwesomeFeatureEnabled", defaultValue: false, user: currentUser); @@ -82,8 +86,10 @@ var isMyAwesomeFeatureEnabled = client.GetValue( ## Sample/Demo apps * [Sample Console App](https://github.com/configcat/.net-sdk/tree/master/samples/ConsoleApp) - * [Sample Web App](https://github.com/configcat/.net-sdk/tree/master/samples/ASP.NETCore) - + * [Sample Multi Page Web App](https://github.com/configcat/.net-sdk/tree/master/samples/ASP.NETCore) + * [Sample Single Page Web App](https://github.com/configcat/.net-sdk/tree/master/samples/BlazorWasm) + * [Sample Mobile/Windows Store App](https://github.com/configcat/.net-sdk/tree/master/samples/MAUI) + ## Polling Modes The ConfigCat SDK supports 3 different polling mechanisms to acquire the setting values from ConfigCat. After latest setting values are downloaded, they are stored in the internal cache then all requests are served from there. Read more about Polling Modes and how to use them at [ConfigCat Docs](https://configcat.com/docs/sdk-reference/dotnet/). diff --git a/samples/ASP.NETCore/README.md b/samples/ASP.NETCore/README.md index fbf0bea7..04d1ef04 100644 --- a/samples/ASP.NETCore/README.md +++ b/samples/ASP.NETCore/README.md @@ -2,7 +2,7 @@ This is a simple .NET Core web application to demonstrate how to use the ConfigCat SDK. -1. Install [.NET Core](https://dotnet.microsoft.com/download) +1. Install the [.NET SDK](https://dotnet.microsoft.com/download) 2. Change dir to `/WebApplication` ```bash cd WebApplication diff --git a/samples/BlazorWasm/README.md b/samples/BlazorWasm/README.md index 36f1fe41..a48ef710 100644 --- a/samples/BlazorWasm/README.md +++ b/samples/BlazorWasm/README.md @@ -2,7 +2,7 @@ This is a simple [ASP.NET Core Blazor WebAssembly](https://learn.microsoft.com/en-us/aspnet/core/blazor) application to demonstrate how to use the ConfigCat SDK. -1. Install the [.NET 8 SDK](https://dotnet.microsoft.com/download) +1. Install the [.NET SDK](https://dotnet.microsoft.com/download) 2. Run app ```bash dotnet run -- urls=http://localhost:5000 diff --git a/samples/ConsoleApp/README.md b/samples/ConsoleApp/README.md index 64e1393d..01d462cc 100644 --- a/samples/ConsoleApp/README.md +++ b/samples/ConsoleApp/README.md @@ -1,8 +1,8 @@ -# Sample .NET Core Console app +# Sample .NET Console app -This is a simple .NET Core Console application to demonstrate how to use the ConfigCat SDK. +This is a simple .NET Console application to demonstrate how to use the ConfigCat SDK. -1. Install [.NET Core](https://dotnet.microsoft.com/download) +1. Install the [.NET SDK](https://dotnet.microsoft.com/download) 2. Run sample app: ```bash diff --git a/samples/UnityWebGL/README.md b/samples/UnityWebGL/README.md index 32e7f714..299fc2da 100644 --- a/samples/UnityWebGL/README.md +++ b/samples/UnityWebGL/README.md @@ -13,4 +13,4 @@ Since NuGet packages cannot be referenced in Unity projects directly, the SDK's * [System.Text.Json v6.0.0](https://www.nuget.org/packages/System.Text.Json/6.0.0) * [System.Threading.Tasks.Extensions v4.5.4](https://www.nuget.org/packages/System.Threading.Tasks.Extensions/4.5.4) -Tested on Unity 2021.3 LTS. \ No newline at end of file +Tested on Unity 2021.3 LTS and 6000.0. \ No newline at end of file