diff --git a/docs/coding-guidelines/libraries-packaging.md b/docs/coding-guidelines/libraries-packaging.md index 2d6968bce65000..25a2894cfe9ae5 100644 --- a/docs/coding-guidelines/libraries-packaging.md +++ b/docs/coding-guidelines/libraries-packaging.md @@ -40,22 +40,29 @@ Libraries to be packaged must set `IsPackable` to true. By default, all `librari Package versions and shipping state should be controlled using the properties defined by the [Arcade SDK](https://github.com/dotnet/arcade/blob/master/Documentation/ArcadeSdk.md#project-properties-defined-by-the-sdk). Typically libraries should not need to explicitly set any of these properties. -Most metadata for packages is controlled centrally in the repository and individual projects may not need to make any changes to these. One property is required to be set in each project: `PackageDescription`. This should be set to a descriptive summary of the purpose of the package, and a list of common entry-point types for the package: to aide in search engine optimization. Example: +Most metadata for packages is controlled centrally in the repository and individual projects may not need to make any changes to these. One property is required to be set in each project: `PackageDescription`. This should be set to a descriptive summary of the purpose of the package. Example: + ```xml -Logging abstractions for Microsoft.Extensions.Logging. - -Commonly Used Types: -Microsoft.Extensions.Logging.ILogger -Microsoft.Extensions.Logging.ILoggerFactory -Microsoft.Extensions.Logging.ILogger<TCategoryName> -Microsoft.Extensions.Logging.LogLevel -Microsoft.Extensions.Logging.Logger<T> -Microsoft.Extensions.Logging.LoggerMessage -Microsoft.Extensions.Logging.Abstractions.NullLogger +Logging abstractions for Microsoft.Extensions.Logging. ``` Package content can be defined using any of the publicly defined Pack inputs: https://docs.microsoft.com/en-us/nuget/reference/msbuild-targets +### Package Readme + +Packages can include a Markdown Readme file with a short usage documentation. To include a package Readme, create a `PACKAGE.md` file in the library `src` directory. The file will be automatically included in the package and used as a Readme if its name matches this convention. + +The package Readme is displayed on the package details page on [NuGet gallery](https://nuget.org/). You can include the following content in it: + +- A description of the package purpose. +- Information when package should be used. For example, if the library is included in the shared framework in .NET, but needs to be installed via NuGet on .NET Framework, it should be mentioned. +- Information on how to get started with the package. +- Links to related documentation. +- A list of common entry-point types for the package, with links to their API docs under [.NET API Browser](https://learn.microsoft.com/dotnet/api/). +- A short code example that demostrates the package usage. + +For a list of supported Markdown features, see [NuGet documentation](https://learn.microsoft.com/nuget/nuget-org/package-readme-on-nuget-org#supported-markdown-features). + ### Build props / targets and other content Build props and targets may be needed in NuGet packages. To define these, author a build folder in your src project and place the necessary props/targets in this subfolder. You can then add items to include these in the package by defining `Content` items and setting `PackagePath` as follows: diff --git a/eng/packaging.targets b/eng/packaging.targets index 80f4748e1b0fff..c6a8223b0114dc 100644 --- a/eng/packaging.targets +++ b/eng/packaging.targets @@ -11,6 +11,7 @@ true $(MSBuildThisFileDirectory)useSharedDesignerContext.txt + PACKAGE.md + + + + + diff --git a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/README.md b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/README.md index b607b9942a9d5d..0f78d178efa217 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/README.md +++ b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/README.md @@ -1,14 +1,6 @@ # Microsoft.Extensions.Configuration.Abstractions -Provides abstractions of key-value pair based configuration. Interfaces defined in this package are implemented by classes in [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/) and other configuration packages. - -Commonly used types: - -- [Microsoft.Extensions.Configuration.IConfiguration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfiguration) -- [Microsoft.Extensions.Configuration.IConfigurationBuilder](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationbuilder) -- [Microsoft.Extensions.Configuration.IConfigurationProvider](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationprovider) -- [Microsoft.Extensions.Configuration.IConfigurationRoot](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationroot) -- [Microsoft.Extensions.Configuration.IConfigurationSection](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationsection) +Provides abstractions of key-value pair based configuration. Documentation can be found at https://learn.microsoft.com/dotnet/core/extensions/configuration @@ -41,7 +33,7 @@ Console.WriteLine(options.NamedProperty); // returns "value for named property" ``` ## Contribution Bar -- [x] [We consider new features, new APIs, bug fixes, and performance changes](https://github.com/dotnet/runtime/tree/main/src/libraries#contribution-bar) +- [x] [We consider new features, new APIs, bug fixes, and performance changes](../README.md#contribution-bar) The APIs and functionality are mature, but do get extended occasionally. diff --git a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/Microsoft.Extensions.Configuration.Abstractions.csproj b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/Microsoft.Extensions.Configuration.Abstractions.csproj index a75a855ad630de..a24c8c9a93979e 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/Microsoft.Extensions.Configuration.Abstractions.csproj +++ b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/Microsoft.Extensions.Configuration.Abstractions.csproj @@ -3,17 +3,15 @@ $(NetCoreAppCurrent);$(NetCoreAppPrevious);$(NetCoreAppMinimum);netstandard2.0;$(NetFrameworkMinimum) true - true true + true Provides abstractions of key-value pair based configuration. Interfaces defined in this package are implemented by classes in Microsoft.Extensions.Configuration and other configuration packages. - README.md - diff --git a/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/PACKAGE.md new file mode 100644 index 00000000000000..9a93ad1f76eb74 --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Configuration.Abstractions/src/PACKAGE.md @@ -0,0 +1,41 @@ +## About + +Provides abstractions of key-value pair based configuration. Interfaces defined in this package are implemented by classes in [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/) and other configuration packages. + +Commonly used types: + +- [Microsoft.Extensions.Configuration.IConfiguration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfiguration) +- [Microsoft.Extensions.Configuration.IConfigurationBuilder](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationbuilder) +- [Microsoft.Extensions.Configuration.IConfigurationProvider](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationprovider) +- [Microsoft.Extensions.Configuration.IConfigurationRoot](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationroot) +- [Microsoft.Extensions.Configuration.IConfigurationSection](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iconfigurationsection) + +For more information, see the documentation: [Configuration in .NET](https://learn.microsoft.com/dotnet/core/extensions/configuration). + +## Example + +The example below shows a small code sample using this library and trying out the `ConfigurationKeyName` attribute available since .NET 6: + +```cs +public class MyClass +{ + [ConfigurationKeyName("named_property")] + public string NamedProperty { get; set; } +} +``` + +Given the simple class above, we can create a dictionary to hold the configuration data and use it as the memory source to build a configuration section: + +```cs +var dic = new Dictionary +{ + {"named_property", "value for named property"}, +}; + +var config = new ConfigurationBuilder() + .AddInMemoryCollection(dic) + .Build(); + +var options = config.Get(); +Console.WriteLine(options.NamedProperty); // returns "value for named property" +``` diff --git a/src/libraries/Microsoft.Extensions.Configuration.Binder/README.md b/src/libraries/Microsoft.Extensions.Configuration.Binder/README.md index 3ef7a29905e23e..146f3b8a47a48e 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Binder/README.md +++ b/src/libraries/Microsoft.Extensions.Configuration.Binder/README.md @@ -1,11 +1,11 @@ # Microsoft.Extensions.Configuration.Binder -Provides the functionality to bind an object to data in configuration providers for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to represent the configuration data as strongly-typed classes defined in the application code. To bind a configuration, use the [Microsoft.Extensions.Configuration.ConfigurationBinder.Get](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.configurationbinder.get) extension method on the `IConfiguration` object. To use this package, you also need to install a package for the [configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration#configuration-providers), for example, [Microsoft.Extensions.Configuration.Json](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Json/) for the JSON provider. +Provides the functionality to bind an object to data in configuration providers for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). Documentation can be found at https://learn.microsoft.com/dotnet/core/extensions/configuration ## Contribution Bar -- [x] [We consider new features, new APIs, bug fixes, and performance changes](https://github.com/dotnet/runtime/tree/main/src/libraries#contribution-bar) +- [x] [We consider new features, new APIs, bug fixes, and performance changes](../README.md#contribution-bar) The APIs and functionality are mature, but do get extended occasionally. diff --git a/src/libraries/Microsoft.Extensions.Configuration.Binder/src/Microsoft.Extensions.Configuration.Binder.csproj b/src/libraries/Microsoft.Extensions.Configuration.Binder/src/Microsoft.Extensions.Configuration.Binder.csproj index ac8355c9631731..ee09194c0e301c 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Binder/src/Microsoft.Extensions.Configuration.Binder.csproj +++ b/src/libraries/Microsoft.Extensions.Configuration.Binder/src/Microsoft.Extensions.Configuration.Binder.csproj @@ -6,14 +6,12 @@ true true Provides the functionality to bind an object to data in configuration providers for Microsoft.Extensions.Configuration. This package enables you to represent the configuration data as strongly-typed classes defined in the application code. To bind a configuration, use the Microsoft.Extensions.Configuration.ConfigurationBinder.Get extension method on the IConfiguration object. To use this package, you also need to install a package for the configuration provider, for example, Microsoft.Extensions.Configuration.Json for the JSON provider. - README.md - diff --git a/src/libraries/Microsoft.Extensions.Configuration.Binder/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Configuration.Binder/src/PACKAGE.md new file mode 100644 index 00000000000000..ffb402bece35f0 --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Configuration.Binder/src/PACKAGE.md @@ -0,0 +1,83 @@ +## About + +Provides the functionality to bind an object to data in configuration providers for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to represent the configuration data as strongly-typed classes defined in the application code. To bind a configuration, use the [Microsoft.Extensions.Configuration.ConfigurationBinder.Get](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.configurationbinder.get) extension method on the `IConfiguration` object. To use this package, you also need to install a package for the [configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration#configuration-providers), for example, [Microsoft.Extensions.Configuration.Json](https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Json/) for the JSON provider. + +For more information, see the documentation: [Configuration in .NET](https://learn.microsoft.com/dotnet/core/extensions/configuration). + +## Example +The following example shows how to bind a JSON configuration section to .NET objects. + +```cs +using System; +using Microsoft.Extensions.Configuration; + +class Settings +{ + public string Server { get; set; } + public string Database { get; set; } + public Endpoint[] Endpoints { get; set; } +} + +class Endpoint +{ + public string IPAddress { get; set; } + public int Port { get; set; } +} + +class Program +{ + static void Main() + { + // Build a configuration object from JSON file + IConfiguration config = new ConfigurationBuilder() + .AddJsonFile("appsettings.json") + .Build(); + + // Bind a configuration section to an instance of Settings class + Settings settings = config.GetSection("Settings").Get(); + + // Read simple values + Console.WriteLine($"Server: {settings.Server}"); + Console.WriteLine($"Database: {settings.Database}"); + + // Read nested objects + Console.WriteLine("Endpoints: "); + + foreach (Endpoint endpoint in settings.Endpoints) + { + Console.WriteLine($"{endpoint.IPAddress}:{endpoint.Port}"); + } + } +} +``` + +To run this example, include an `appsettings.json` file with the following content in your project: + +```json +{ + "Settings": { + "Server": "example.com", + "Database": "Northwind", + "Endpoints": [ + { + "IPAddress": "192.168.0.1", + "Port": "80" + }, + { + "IPAddress": "192.168.10.1", + "Port": "8080" + } + ] + } +} +``` + +You can include a configuration file using a code like this in your `.csproj` file: + +```xml + + + Always + + +``` diff --git a/src/libraries/Microsoft.Extensions.Configuration.CommandLine/README.md b/src/libraries/Microsoft.Extensions.Configuration.CommandLine/README.md index e2303a425959a1..bc6c928752740b 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.CommandLine/README.md +++ b/src/libraries/Microsoft.Extensions.Configuration.CommandLine/README.md @@ -1,11 +1,11 @@ # Microsoft.Extensions.Configuration.CommandLine -Command line configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read configuration parameters from the command line arguments of your application. You can use [CommandLineConfigurationExtensions.AddCommandLine](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.commandlineconfigurationextensions.addcommandline) extension method on `IConfigurationBuilder` to add the command line configuration provider to the configuration builder. +Command line configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). Documentation can be found at https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#command-line-configuration-provider ## Contribution Bar -- [x] [We consider new features, new APIs, bug fixes, and performance changes](https://github.com/dotnet/runtime/tree/main/src/libraries#contribution-bar) +- [x] [We consider new features, new APIs, bug fixes, and performance changes](../README.md#contribution-bar) The APIs and functionality are mature, but do get extended occasionally. diff --git a/src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/Microsoft.Extensions.Configuration.CommandLine.csproj b/src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/Microsoft.Extensions.Configuration.CommandLine.csproj index 74c9b2bc6bf62b..c41a5babc78a66 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/Microsoft.Extensions.Configuration.CommandLine.csproj +++ b/src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/Microsoft.Extensions.Configuration.CommandLine.csproj @@ -6,7 +6,6 @@ true true Command line configuration provider implementation for Microsoft.Extensions.Configuration. This package enables you to read configuration parameters from the command line arguments of your application. You can use CommandLineConfigurationExtensions.AddCommandLine extension method on IConfigurationBuilder to add the command line configuration provider to the configuration builder. - README.md @@ -14,7 +13,6 @@ - diff --git a/src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/PACKAGE.md new file mode 100644 index 00000000000000..39daac6e4ec6c0 --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/PACKAGE.md @@ -0,0 +1,29 @@ +## About + +Command line configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read configuration parameters from the command line arguments of your application. You can use [CommandLineConfigurationExtensions.AddCommandLine](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.commandlineconfigurationextensions.addcommandline) extension method on `IConfigurationBuilder` to add the command line configuration provider to the configuration builder. + +For more information, see the documentation: [Command-line configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#command-line-configuration-provider). + +## Example + +The following example shows how to read application configuration from the command line. You can use a command like `dotnet run --InputPath "c:\fizz" --OutputPath "c:\buzz"` to run it. + +```cs +using System; +using Microsoft.Extensions.Configuration; + +class Program +{ + static void Main(string[] args) + { + // Build a configuration object from command line + IConfiguration config = new ConfigurationBuilder() + .AddCommandLine(args) + .Build(); + + // Read configuration values + Console.WriteLine($"InputPath: {config["InputPath"]}"); + Console.WriteLine($"OutputPath: {config["OutputPath"]}"); + } +} +``` diff --git a/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/README.md b/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/README.md index 5763e859c105c5..d37d39e74173e2 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/README.md +++ b/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/README.md @@ -1,11 +1,11 @@ # Microsoft.Extensions.Configuration.EnvironmentVariables -Environment variables configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read configuration parameters from environment variables. You can use [EnvironmentVariablesExtensions.AddEnvironmentVariables](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.environmentvariablesextensions.addenvironmentvariables) extension method on `IConfigurationBuilder` to add the environment variables configuration provider to the configuration builder. +Environment variables configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). Documentation can be found at https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#environment-variable-configuration-provider ## Contribution Bar -- [x] [We consider new features, new APIs, bug fixes, and performance changes](https://github.com/dotnet/runtime/tree/main/src/libraries#contribution-bar) +- [x] [We consider new features, new APIs, bug fixes, and performance changes](../README.md#contribution-bar) The APIs and functionality are mature, but do get extended occasionally. diff --git a/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/Microsoft.Extensions.Configuration.EnvironmentVariables.csproj b/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/Microsoft.Extensions.Configuration.EnvironmentVariables.csproj index 6deff79bc9361e..3f1cfccff9655e 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/Microsoft.Extensions.Configuration.EnvironmentVariables.csproj +++ b/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/Microsoft.Extensions.Configuration.EnvironmentVariables.csproj @@ -6,13 +6,11 @@ true true Environment variables configuration provider implementation for Microsoft.Extensions.Configuration. This package enables you to read configuration parameters from environment variables. You can use EnvironmentVariablesExtensions.AddEnvironmentVariables extension method on IConfigurationBuilder to add the environment variables configuration provider to the configuration builder. - README.md - diff --git a/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/PACKAGE.md new file mode 100644 index 00000000000000..84d2d9412cce76 --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Configuration.EnvironmentVariables/src/PACKAGE.md @@ -0,0 +1,28 @@ +## About + +Environment variables configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read configuration parameters from environment variables. You can use [EnvironmentVariablesExtensions.AddEnvironmentVariables](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.environmentvariablesextensions.addenvironmentvariables) extension method on `IConfigurationBuilder` to add the environment variables configuration provider to the configuration builder. + +For more information, see the documentation: [Environment variable configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#environment-variable-configuration-provider). + +## Example +The following example shows how to read application configuration from environment variables. + +```cs +using System; +using Microsoft.Extensions.Configuration; + +class Program +{ + static void Main() + { + // Build a configuration object from environment variables + IConfiguration config = new ConfigurationBuilder() + .AddEnvironmentVariables() + .Build(); + + // Read configuration values + Console.WriteLine($"Server: {config["Server"]}"); + Console.WriteLine($"Database: {config["Database"]}"); + } +} +``` diff --git a/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/README.md b/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/README.md index 868264950becd8..d2cb5f6c643e85 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/README.md +++ b/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/README.md @@ -2,15 +2,10 @@ Provides a base class for file-based configuration providers used with [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/) and extension methods for configuring them. -Commonly used types: - -- [Microsoft.Extensions.Configuration.FileConfigurationProvider](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.fileconfigurationprovider) -- [Microsoft.Extensions.Configuration.FileConfigurationExtensions](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.fileconfigurationextensions) - Documentation can be found at https://learn.microsoft.com/dotnet/core/extensions/configuration ## Contribution Bar -- [x] [We consider new features, new APIs, bug fixes, and performance changes](https://github.com/dotnet/runtime/tree/main/src/libraries#contribution-bar) +- [x] [We consider new features, new APIs, bug fixes, and performance changes](../README.md#contribution-bar) The APIs and functionality are mature, but do get extended occasionally. diff --git a/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/Microsoft.Extensions.Configuration.FileExtensions.csproj b/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/Microsoft.Extensions.Configuration.FileExtensions.csproj index 700e70fba3f90a..a297422d44ca8a 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/Microsoft.Extensions.Configuration.FileExtensions.csproj +++ b/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/Microsoft.Extensions.Configuration.FileExtensions.csproj @@ -6,7 +6,6 @@ true true Provides a base class for file-based configuration providers used with Microsoft.Extensions.Configuration and extension methods for configuring them. - README.md @@ -17,7 +16,6 @@ - diff --git a/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/PACKAGE.md new file mode 100644 index 00000000000000..e43c909d83225c --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/PACKAGE.md @@ -0,0 +1,9 @@ +## About + +Provides a base class for file-based configuration providers used with [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/) and extension methods for configuring them. + +For more information, see the documentation: + +- [Configuration in .NET](https://learn.microsoft.com/dotnet/core/extensions/configuration) +- [Microsoft.Extensions.Configuration.FileConfigurationProvider](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.fileconfigurationprovider) +- [Microsoft.Extensions.Configuration.FileConfigurationExtensions](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.fileconfigurationextensions) diff --git a/src/libraries/Microsoft.Extensions.Configuration.Ini/README.md b/src/libraries/Microsoft.Extensions.Configuration.Ini/README.md index 0e7ca833b61e34..301e1c744855e4 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Ini/README.md +++ b/src/libraries/Microsoft.Extensions.Configuration.Ini/README.md @@ -1,11 +1,11 @@ # Microsoft.Extensions.Configuration.Ini -INI configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read configuration parameters from [INI files](https://en.wikipedia.org/wiki/INI_file). You can use [IniConfigurationExtensions.AddIniFile](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iniconfigurationextensions.addinifile) extension method on `IConfigurationBuilder` to add INI configuration provider to the configuration builder. +INI configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). Documentation can be found at https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#ini-configuration-provider ## Contribution Bar -- [x] [We consider new features, new APIs, bug fixes, and performance changes](https://github.com/dotnet/runtime/tree/main/src/libraries#contribution-bar) +- [x] [We consider new features, new APIs, bug fixes, and performance changes](../README.md#contribution-bar) The APIs and functionality are mature, but do get extended occasionally. diff --git a/src/libraries/Microsoft.Extensions.Configuration.Ini/src/Microsoft.Extensions.Configuration.Ini.csproj b/src/libraries/Microsoft.Extensions.Configuration.Ini/src/Microsoft.Extensions.Configuration.Ini.csproj index 40aceeafa07d70..6b3de742cf0f12 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Ini/src/Microsoft.Extensions.Configuration.Ini.csproj +++ b/src/libraries/Microsoft.Extensions.Configuration.Ini/src/Microsoft.Extensions.Configuration.Ini.csproj @@ -6,7 +6,6 @@ true true INI configuration provider implementation for Microsoft.Extensions.Configuration. This package enables you to read configuration parameters from INI files. You can use IniConfigurationExtensions.AddIniFile extension method on IConfigurationBuilder to add INI configuration provider to the configuration builder. - README.md @@ -16,7 +15,6 @@ - diff --git a/src/libraries/Microsoft.Extensions.Configuration.Ini/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Configuration.Ini/src/PACKAGE.md new file mode 100644 index 00000000000000..7322364392c600 --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Configuration.Ini/src/PACKAGE.md @@ -0,0 +1,49 @@ +## About + +INI configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read configuration parameters from [INI files](https://en.wikipedia.org/wiki/INI_file). You can use [IniConfigurationExtensions.AddIniFile](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.iniconfigurationextensions.addinifile) extension method on `IConfigurationBuilder` to add INI configuration provider to the configuration builder. + +For more information, see the documentation: [INI configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#ini-configuration-provider). + +## Example +The following example shows how to read the application configuration from INI file. + +```cs +using System; +using Microsoft.Extensions.Configuration; + +class Program +{ + static void Main() + { + // Build a configuration object from INI file + IConfiguration config = new ConfigurationBuilder() + .AddIniFile("appsettings.ini") + .Build(); + + // Get a configuration section + IConfigurationSection section = config.GetSection("Settings"); + + // Read configuration values + Console.WriteLine($"Server: {section["Server"]}"); + Console.WriteLine($"Database: {section["Database"]}"); + } +} +``` + +To run this example, include an `appsettings.ini` file with the following content in your project: + +``` +[Settings] +Server=example.com +Database=Northwind +``` + +You can include a configuration file using a code like this in your `.csproj` file: + +```xml + + + Always + + +``` diff --git a/src/libraries/Microsoft.Extensions.Configuration.Json/README.md b/src/libraries/Microsoft.Extensions.Configuration.Json/README.md index 82a2069a2ec566..b9740c0fa213be 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Json/README.md +++ b/src/libraries/Microsoft.Extensions.Configuration.Json/README.md @@ -1,11 +1,11 @@ # Microsoft.Extensions.Configuration.Json -JSON configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read your application's settings from a JSON file. You can use [JsonConfigurationExtensions.AddJsonFile](https://docs.microsoft.com/dotnet/api/microsoft.extensions.configuration.jsonconfigurationextensions.addjsonfile) extension method on `IConfigurationBuilder` to add the JSON configuration provider to the configuration builder. +JSON configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). Documentation can be found at https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#json-configuration-provider ## Contribution Bar -- [x] [We consider new features, new APIs, bug fixes, and performance changes](https://github.com/dotnet/runtime/tree/main/src/libraries#contribution-bar) +- [x] [We consider new features, new APIs, bug fixes, and performance changes](../README.md#contribution-bar) The APIs and functionality are mature, but do get extended occasionally. diff --git a/src/libraries/Microsoft.Extensions.Configuration.Json/src/Microsoft.Extensions.Configuration.Json.csproj b/src/libraries/Microsoft.Extensions.Configuration.Json/src/Microsoft.Extensions.Configuration.Json.csproj index ba7f3c99cccbdf..17a12b378ab45b 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Json/src/Microsoft.Extensions.Configuration.Json.csproj +++ b/src/libraries/Microsoft.Extensions.Configuration.Json/src/Microsoft.Extensions.Configuration.Json.csproj @@ -7,7 +7,6 @@ true true JSON configuration provider implementation for Microsoft.Extensions.Configuration. This package enables you to read your application's settings from a JSON file. You can use JsonConfigurationExtensions.AddJsonFile extension method on IConfigurationBuilder to add the JSON configuration provider to the configuration builder. - README.md @@ -18,7 +17,6 @@ - diff --git a/src/libraries/Microsoft.Extensions.Configuration.Json/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Configuration.Json/src/PACKAGE.md new file mode 100644 index 00000000000000..ae1c6355100f3a --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Configuration.Json/src/PACKAGE.md @@ -0,0 +1,62 @@ +## About + +JSON configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read your application's settings from a JSON file. You can use [JsonConfigurationExtensions.AddJsonFile](https://docs.microsoft.com/dotnet/api/microsoft.extensions.configuration.jsonconfigurationextensions.addjsonfile) extension method on `IConfigurationBuilder` to add the JSON configuration provider to the configuration builder. + +For more information, see the documentation: [JSON configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#json-configuration-provider). + +## Example +The following example shows how to read application settings from the JSON configuration file. + +```cs +using System; +using Microsoft.Extensions.Configuration; + +class Program +{ + static void Main() + { + // Build a configuration object from JSON file + IConfiguration config = new ConfigurationBuilder() + .AddJsonFile("appsettings.json") + .Build(); + + // Get a configuration section + IConfigurationSection section = config.GetSection("Settings"); + + // Read simple values + Console.WriteLine($"Server: {section["Server"]}"); + Console.WriteLine($"Database: {section["Database"]}"); + + // Read a collection + Console.WriteLine("Ports: "); + IConfigurationSection ports = section.GetSection("Ports"); + + foreach (IConfigurationSection child in ports.GetChildren()) + { + Console.WriteLine(child.Value); + } + } +} +``` + +To run this example, include an `appsettings.json` file with the following content in your project: + +```json +{ + "Settings": { + "Server": "example.com", + "Database": "Northwind", + "Ports": [ 80, 81 ] + } +} +``` + +You can include a configuration file using a code like this in your `.csproj` file: + +```xml + + + Always + + +``` diff --git a/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/README.md b/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/README.md index cb40305e004741..342c97ca8c5fd7 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/README.md +++ b/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/README.md @@ -1,11 +1,11 @@ # Microsoft.Extensions.Configuration.UserSecrets -User secrets configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). User secrets mechanism enables you to override application configuration settings with values stored in the local secrets file. You can use [UserSecretsConfigurationExtensions.AddUserSecrets](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.usersecretsconfigurationextensions.addusersecrets) extension method on `IConfigurationBuilder` to add user secrets provider to the configuration builder. +User secrets configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). Documentation can be found at https://learn.microsoft.com/aspnet/core/security/app-secrets ## Contribution Bar -- [x] [We consider new features, new APIs, bug fixes, and performance changes](https://github.com/dotnet/runtime/tree/main/src/libraries#contribution-bar) +- [x] [We consider new features, new APIs, bug fixes, and performance changes](../README.md#contribution-bar) The APIs and functionality are mature, but do get extended occasionally. diff --git a/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/Microsoft.Extensions.Configuration.UserSecrets.csproj b/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/Microsoft.Extensions.Configuration.UserSecrets.csproj index a306364a710ec2..09d270792b8e6d 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/Microsoft.Extensions.Configuration.UserSecrets.csproj +++ b/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/Microsoft.Extensions.Configuration.UserSecrets.csproj @@ -6,7 +6,6 @@ true true User secrets configuration provider implementation for Microsoft.Extensions.Configuration. User secrets mechanism enables you to override application configuration settings with values stored in the local secrets file. You can use UserSecretsConfigurationExtensions.AddUserSecrets extension method on IConfigurationBuilder to add user secrets provider to the configuration builder. - README.md @@ -16,7 +15,6 @@ - diff --git a/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/PACKAGE.md new file mode 100644 index 00000000000000..4dba7ccd6bbb5d --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/PACKAGE.md @@ -0,0 +1,8 @@ +## About + +User secrets configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). User secrets mechanism enables you to override application configuration settings with values stored in the local secrets file. You can use [UserSecretsConfigurationExtensions.AddUserSecrets](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.usersecretsconfigurationextensions.addusersecrets) extension method on `IConfigurationBuilder` to add user secrets provider to the configuration builder. + +For more information, see the documentation: + +- [Configuration in .NET](https://learn.microsoft.com/dotnet/core/extensions/configuration) +- [Safe storage of app secrets in development in ASP.NET Core](https://learn.microsoft.com/aspnet/core/security/app-secrets) diff --git a/src/libraries/Microsoft.Extensions.Configuration.Xml/README.md b/src/libraries/Microsoft.Extensions.Configuration.Xml/README.md index d95c384cbc57f2..42fa34f6301055 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Xml/README.md +++ b/src/libraries/Microsoft.Extensions.Configuration.Xml/README.md @@ -1,11 +1,11 @@ # Microsoft.Extensions.Configuration.Xml -XML configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read configuration parameters from XML files. You can use [XmlConfigurationExtensions.AddXmlFile](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.xmlconfigurationextensions.addxmlfile) extension method on `IConfigurationBuilder` to add XML configuration provider to the configuration builder. +XML configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). Documentation can be found at https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#xml-configuration-provider ## Contribution Bar -- [x] [We consider new features, new APIs, bug fixes, and performance changes](https://github.com/dotnet/runtime/tree/main/src/libraries#contribution-bar) +- [x] [We consider new features, new APIs, bug fixes, and performance changes](../README.md#contribution-bar) The APIs and functionality are mature, but do get extended occasionally. diff --git a/src/libraries/Microsoft.Extensions.Configuration.Xml/src/Microsoft.Extensions.Configuration.Xml.csproj b/src/libraries/Microsoft.Extensions.Configuration.Xml/src/Microsoft.Extensions.Configuration.Xml.csproj index c528727f40476f..88b010ec4b097b 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Xml/src/Microsoft.Extensions.Configuration.Xml.csproj +++ b/src/libraries/Microsoft.Extensions.Configuration.Xml/src/Microsoft.Extensions.Configuration.Xml.csproj @@ -6,7 +6,6 @@ true true XML configuration provider implementation for Microsoft.Extensions.Configuration. This package enables you to read configuration parameters from XML files. You can use XmlConfigurationExtensions.AddXmlFile extension method on IConfigurationBuilder to add XML configuration provider to the configuration builder. - README.md @@ -17,7 +16,6 @@ - diff --git a/src/libraries/Microsoft.Extensions.Configuration.Xml/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Configuration.Xml/src/PACKAGE.md new file mode 100644 index 00000000000000..d47be06c8dea3b --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Configuration.Xml/src/PACKAGE.md @@ -0,0 +1,61 @@ +## About + +XML configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read configuration parameters from XML files. You can use [XmlConfigurationExtensions.AddXmlFile](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration.xmlconfigurationextensions.addxmlfile) extension method on `IConfigurationBuilder` to add XML configuration provider to the configuration builder. + +For more information, see the documentation: [XML configuration provider](https://learn.microsoft.com/dotnet/core/extensions/configuration-providers#xml-configuration-provider). + +## Example +The following example shows how to read the application configuration from XML file. + +```cs +using System; +using Microsoft.Extensions.Configuration; + +class Program +{ + static void Main() + { + // Build a configuration object from XML file + IConfiguration config = new ConfigurationBuilder() + .AddXmlFile("appsettings.xml") + .Build(); + + // Get a configuration section + IConfigurationSection section = config.GetSection("Settings"); + + // Read simple values + Console.WriteLine($"Server: {section["Server"]}"); + Console.WriteLine($"Database: {section["Database"]}"); + + // Read nested values + Console.WriteLine($"IPAddress: {section["Endpoint:IPAddress"]}"); + Console.WriteLine($"Port: {section["Endpoint:Port"]}"); + } +} +``` + +To run this example, include an `appsettings.xml` file with the following content in your project: + +```xml + + + + example.com + Northwind + + 192.168.0.10 + 80 + + + +``` + +You can include a configuration file using a code like this in your `.csproj` file: + +```xml + + + Always + + +``` diff --git a/src/libraries/Microsoft.Extensions.Configuration/README.md b/src/libraries/Microsoft.Extensions.Configuration/README.md index 63b5c311134a1c..73c432729cf015 100644 --- a/src/libraries/Microsoft.Extensions.Configuration/README.md +++ b/src/libraries/Microsoft.Extensions.Configuration/README.md @@ -1,11 +1,11 @@ # Microsoft.Extensions.Configuration -`Microsoft.Extensions.Configuration` is combined with a core configuration abstraction under `Microsoft.Extensions.Configuration.Abstractions` that allows for building different kinds of configuration providers to retrieve key/value pair configuration values from in the form of `IConfiguration`. There are a number of built-in configuration provider implementations to read from environment variables, in-memory collections, JSON, INI or XML files. Aside from the built-in variations, there are more shipped libraries shipped by community for integration with various configuration service and other data sources. +`Microsoft.Extensions.Configuration` is combined with a core configuration abstraction under `Microsoft.Extensions.Configuration.Abstractions` that allows for building different kinds of configuration providers to retrieve key/value pair configuration values from in the form of `IConfiguration`. Documentation can be found at https://learn.microsoft.com/en-us/dotnet/core/extensions/configuration. ## Contribution Bar -- [x] [We consider new features, new APIs, bug fixes, and performance changes](https://github.com/dotnet/runtime/tree/main/src/libraries#contribution-bar) +- [x] [We consider new features, new APIs, bug fixes, and performance changes](../README.md#contribution-bar) The APIs and functionality are mature, but do get extended occasionally. diff --git a/src/libraries/Microsoft.Extensions.Configuration/src/Microsoft.Extensions.Configuration.csproj b/src/libraries/Microsoft.Extensions.Configuration/src/Microsoft.Extensions.Configuration.csproj index 0aed454a272107..b1993353676905 100644 --- a/src/libraries/Microsoft.Extensions.Configuration/src/Microsoft.Extensions.Configuration.csproj +++ b/src/libraries/Microsoft.Extensions.Configuration/src/Microsoft.Extensions.Configuration.csproj @@ -6,7 +6,6 @@ true true Implementation of key-value pair based configuration for Microsoft.Extensions.Configuration. Includes the memory configuration provider. - README.md @@ -18,7 +17,6 @@ Link="Common\src\Extensions\EmptyDisposable.cs" /> - diff --git a/src/libraries/Microsoft.Extensions.Configuration/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Configuration/src/PACKAGE.md new file mode 100644 index 00000000000000..92e93652f7a609 --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Configuration/src/PACKAGE.md @@ -0,0 +1,8 @@ +## About + +`Microsoft.Extensions.Configuration` is combined with a core configuration abstraction under `Microsoft.Extensions.Configuration.Abstractions` that allows for building different kinds of configuration providers to retrieve key/value pair configuration values from in the form of `IConfiguration`. There are a number of built-in configuration provider implementations to read from environment variables, in-memory collections, JSON, INI or XML files. Aside from the built-in variations, there are more shipped libraries shipped by community for integration with various configuration service and other data sources. + +For more information, see the documentation: + +- [Configuration in .NET](https://learn.microsoft.com/dotnet/core/extensions/configuration) +- [Microsoft.Extensions.Configuration namespace](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration) diff --git a/src/libraries/Microsoft.Extensions.DependencyModel/src/Microsoft.Extensions.DependencyModel.csproj b/src/libraries/Microsoft.Extensions.DependencyModel/src/Microsoft.Extensions.DependencyModel.csproj index a033525dee6db7..d964b3506d4771 100644 --- a/src/libraries/Microsoft.Extensions.DependencyModel/src/Microsoft.Extensions.DependencyModel.csproj +++ b/src/libraries/Microsoft.Extensions.DependencyModel/src/Microsoft.Extensions.DependencyModel.csproj @@ -2,12 +2,11 @@ $(NetCoreAppCurrent);$(NetCoreAppPrevious);$(NetCoreAppMinimum);netstandard2.0;$(NetFrameworkMinimum) true - true true + true Provides abstractions for reading `.deps` files. When a .NET application is compiled, the SDK generates a JSON manifest file (`<ApplicationName>.deps.json`) that contains information about application dependencies. You can use `Microsoft.Extensions.DependencyModel` to read information from this manifest at run time. This is useful when you want to dynamically compile code (for example, using Roslyn Emit API) referencing the same dependencies as your main application. By default, the dependency manifest contains information about the application's target framework and runtime dependencies. Set the PreserveCompilationContext project property to `true` to additionally include information about reference assemblies used during compilation. - README.md @@ -15,7 +14,6 @@ By default, the dependency manifest contains information about the application's Link="System\Numerics\Hashing\HashHelpers.cs" /> - diff --git a/src/libraries/Microsoft.Extensions.DependencyModel/src/README.md b/src/libraries/Microsoft.Extensions.DependencyModel/src/PACKAGE.md similarity index 100% rename from src/libraries/Microsoft.Extensions.DependencyModel/src/README.md rename to src/libraries/Microsoft.Extensions.DependencyModel/src/PACKAGE.md diff --git a/src/libraries/System.Collections.Immutable/src/README.md b/src/libraries/System.Collections.Immutable/src/PACKAGE.md similarity index 100% rename from src/libraries/System.Collections.Immutable/src/README.md rename to src/libraries/System.Collections.Immutable/src/PACKAGE.md diff --git a/src/libraries/System.Collections.Immutable/src/System.Collections.Immutable.csproj b/src/libraries/System.Collections.Immutable/src/System.Collections.Immutable.csproj index d97a732264f299..6953b7908724ff 100644 --- a/src/libraries/System.Collections.Immutable/src/System.Collections.Immutable.csproj +++ b/src/libraries/System.Collections.Immutable/src/System.Collections.Immutable.csproj @@ -5,7 +5,6 @@ This package provides collections that are thread safe and guaranteed to never change their contents, also known as immutable collections. Like strings, any methods that perform modifications will not change the existing instance but instead return a new instance. For efficiency reasons, the implementation uses a sharing mechanism to ensure that newly created instances share as much data as possible with the previous instance while ensuring that operations have a predictable time complexity. The System.Collections.Immutable library is built-in as part of the shared framework in .NET Runtime. The package can be installed when you need to use it in other target frameworks. - README.md true @@ -128,7 +127,6 @@ The System.Collections.Immutable library is built-in as part of the shared frame - diff --git a/src/libraries/System.Configuration.ConfigurationManager/src/README.md b/src/libraries/System.Configuration.ConfigurationManager/src/PACKAGE.md similarity index 100% rename from src/libraries/System.Configuration.ConfigurationManager/src/README.md rename to src/libraries/System.Configuration.ConfigurationManager/src/PACKAGE.md diff --git a/src/libraries/System.Configuration.ConfigurationManager/src/System.Configuration.ConfigurationManager.csproj b/src/libraries/System.Configuration.ConfigurationManager/src/System.Configuration.ConfigurationManager.csproj index 8fd88af01cca74..0662639c81dcab 100644 --- a/src/libraries/System.Configuration.ConfigurationManager/src/System.Configuration.ConfigurationManager.csproj +++ b/src/libraries/System.Configuration.ConfigurationManager/src/System.Configuration.ConfigurationManager.csproj @@ -8,7 +8,6 @@ $(NoWarn);CA1847 true Provides types that support using XML configuration files (app.config). This package exists only to support migrating existing .NET Framework code that already uses System.Configuration. When writing new code, use another configuration system instead, such as Microsoft.Extensions.Configuration. - README.md @@ -289,8 +288,4 @@ - - - - diff --git a/src/libraries/System.Reflection.Metadata/src/README.md b/src/libraries/System.Reflection.Metadata/src/PACKAGE.md similarity index 100% rename from src/libraries/System.Reflection.Metadata/src/README.md rename to src/libraries/System.Reflection.Metadata/src/PACKAGE.md diff --git a/src/libraries/System.Reflection.Metadata/src/System.Reflection.Metadata.csproj b/src/libraries/System.Reflection.Metadata/src/System.Reflection.Metadata.csproj index 69ff5cf8de56f5..04cbedc65b3c70 100644 --- a/src/libraries/System.Reflection.Metadata/src/System.Reflection.Metadata.csproj +++ b/src/libraries/System.Reflection.Metadata/src/System.Reflection.Metadata.csproj @@ -8,7 +8,6 @@ This package provides a low-level .NET (ECMA-335) metadata reader and writer. It's geared for performance and is the ideal choice for building higher-level libraries that intend to provide their own object model, such as compilers. The metadata format is defined by the ECMA-335 - Common Language Infrastructure (CLI) specification. The System.Reflection.Metadata library is built-in as part of the shared framework in .NET Runtime. The package can be installed when you need to use it in other target frameworks. - README.md @@ -90,7 +89,6 @@ The System.Reflection.Metadata library is built-in as part of the shared framewo - diff --git a/src/libraries/System.Reflection.MetadataLoadContext/src/README.md b/src/libraries/System.Reflection.MetadataLoadContext/src/PACKAGE.md similarity index 100% rename from src/libraries/System.Reflection.MetadataLoadContext/src/README.md rename to src/libraries/System.Reflection.MetadataLoadContext/src/PACKAGE.md diff --git a/src/libraries/System.Reflection.MetadataLoadContext/src/System.Reflection.MetadataLoadContext.csproj b/src/libraries/System.Reflection.MetadataLoadContext/src/System.Reflection.MetadataLoadContext.csproj index f38bb38480114e..d3e6bd86389d56 100644 --- a/src/libraries/System.Reflection.MetadataLoadContext/src/System.Reflection.MetadataLoadContext.csproj +++ b/src/libraries/System.Reflection.MetadataLoadContext/src/System.Reflection.MetadataLoadContext.csproj @@ -5,7 +5,6 @@ true true Provides read-only reflection on assemblies in an isolated context with support for assemblies that target different processor architectures and runtimes. Using MetadataLoadContext enables you to inspect assemblies without loading them into the main execution context. Assemblies in MetadataLoadContext are treated only as metadata, that is, you can read information about their members, but cannot execute any code contained in them. - README.md @@ -142,7 +141,6 @@ - diff --git a/src/libraries/System.Text.Json/src/README.md b/src/libraries/System.Text.Json/src/PACKAGE.md similarity index 100% rename from src/libraries/System.Text.Json/src/README.md rename to src/libraries/System.Text.Json/src/PACKAGE.md diff --git a/src/libraries/System.Text.Json/src/System.Text.Json.csproj b/src/libraries/System.Text.Json/src/System.Text.Json.csproj index 13ef04061cdf2e..32758d44325f7b 100644 --- a/src/libraries/System.Text.Json/src/System.Text.Json.csproj +++ b/src/libraries/System.Text.Json/src/System.Text.Json.csproj @@ -7,13 +7,12 @@ CS8969 true - true true + true Provides high-performance and low-allocating types that serialize objects to JavaScript Object Notation (JSON) text and deserialize JSON text to objects, with UTF-8 support built-in. Also provides types to read and write JSON text encoded as UTF-8, and to create an in-memory document object model (DOM), that is read-only, for random access of the JSON elements within a structured view of the data. The System.Text.Json library is built-in as part of the shared framework in .NET Runtime. The package can be installed when you need to use it in other target frameworks. - README.md @@ -322,7 +321,6 @@ The System.Text.Json library is built-in as part of the shared framework in .NET -