build: Add README to package and deprecation notice (#549)

Signed-off-by: André Silva <[email protected]>

Author: askpt

src/OpenFeature.Contrib.Providers.Flagd/OpenFeature.Contrib.Providers.Flagd.csproj

@@ -10,6 +10,8 @@
     <Description>flagd provider for .NET</Description>
     <Authors>Todd Baert</Authors>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
+    <OpenFeatureVersion>[2.9,2.99999]</OpenFeatureVersion>
   </PropertyGroup>
 
   <PropertyGroup Label="SourceLink">
@@ -24,10 +26,9 @@
     <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleTo">
       <_Parameter1>$(MSBuildProjectName).Test</_Parameter1>
     </AssemblyAttribute>
+    <None Include="README.md" Pack="true" PackagePath="\" />
   </ItemGroup>
-  <ItemGroup Condition="'$(TargetFramework)' == 'net462'">
-    <PackageReference Include="System.Net.Http.WinHttpHandler" Version="8.0.2" />
-  </ItemGroup>
+
   <ItemGroup>
     <!-- The schema.proto file referenced here will be used to automatically generate the Grpc
     client when executing 'dotnet build' -->
@@ -47,8 +48,6 @@
     <PackageReference Include="Microsoft.CSharp" Version="4.7.0" Condition="'$(TargetFramework)' == 'netstandard2.0'" />
     <PackageReference Include="OpenFeature" Version="$(OpenFeatureVersion)" />
     <PackageReference Include="OpenFeature.Hosting" Version="$(OpenFeatureVersion)" />
+    <PackageReference Include="System.Net.Http.WinHttpHandler" Version="8.0.2" Condition="'$(TargetFramework)' == 'net462'" />
   </ItemGroup>
-  <PropertyGroup>
-    <OpenFeatureVersion>[2.9,2.99999]</OpenFeatureVersion>
-  </PropertyGroup>
 </Project>

src/OpenFeature.Contrib.Providers.Flagd/README.md

@@ -1,8 +1,8 @@
 # flagd .NET Provider
 
-The flagd Flag provider allows you to connect to your flagd instance.  
+> **⚠️ DEPRECATED**: This package will be renamed to `OpenFeature.Providers.Flagd` (removing the "Contrib" suffix) in a future release. The current package name will be deprecated in favour of the new package name.
 
-# .Net SDK usage
+The flagd Flag provider allows you to connect to your flagd instance.
 
 ## Requirements
 
@@ -189,7 +189,7 @@ Alternatively, if you would like to pass the URI directly, you can initialise it
 var flagdProvider = new FlagdProvider(new Uri("http://localhost:8013"));
 
 // ... or use the unix:// prefix if the provider should communicate via a unix socket
-var unixFlagdProvider = new FlagdProvider(new Uri("unix://socket.tmp"));  
+var unixFlagdProvider = new FlagdProvider(new Uri("unix://socket.tmp"));
 ```
 
 ## In-process resolver type
@@ -241,10 +241,9 @@ namespace OpenFeatureTestApp
 
 By default the in-process provider will attempt to validate the flag configurations against the [Flags](https://flagd.dev/schema/v0/flags.json) and [targeting](https://flagd.dev/schema/v0/targeting.json) schemas. If validation fails a warning log will be generated. You must configure a logger using the FlagdConfigBuilder. The in-process provider uses the Microsoft.Extensions.Logging abstractions.
 
-```
+```csharp
 var logger = loggerFactory.CreateLogger<Program>();
 var flagdConfig = new FlagdConfigBuilder()
     .WithLogger(logger)
     .Build();
 ```
-