More clean-up
authorViktor Hofer <viktor.hofer@microsoft.com>
Mon, 18 Sep 2023 13:57:55 +0000 (15:57 +0200)
committerViktor Hofer <viktor.hofer@microsoft.com>
Mon, 18 Sep 2023 14:24:52 +0000 (16:24 +0200)
src/libraries/Microsoft.Bcl.Numerics/src/PACKAGE.md
src/libraries/Microsoft.Extensions.Configuration.CommandLine/src/PACKAGE.md
src/libraries/Microsoft.Extensions.Configuration.Ini/src/PACKAGE.md
src/libraries/Microsoft.Extensions.Configuration/src/PACKAGE.md
src/libraries/System.Collections.Immutable/src/PACKAGE.md
src/libraries/System.Reflection.Metadata/src/PACKAGE.md

index 620514e..5ce176a 100644 (file)
@@ -8,9 +8,10 @@ As of .NET Core 2.0 and .NET Standard 2.1, the C# language has support for math
 
 * Enables the use of MathF on older .NET platforms
 
-
 ## How to Use
 
+<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
+
 ```C#
 using System;
 
index 8b1734c..3714573 100644 (file)
@@ -4,6 +4,32 @@
 
 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.
 
+## How to Use
+
+<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
+
+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.
+
+```C#
+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"]}");
+    }
+}
+```
+
 ## Additional Documentation
 
 <!-- Links to further documentation -->
index 0fc6604..a987b88 100644 (file)
@@ -4,6 +4,51 @@
 
 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.
 
+## How to Use
+
+<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
+
+```C#
+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
+<ItemGroup>
+  <Content Include="appsettings.ini">
+    <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+  </Content>
+</ItemGroup>
+```
+
 ## Additional Documentation
 
 <!-- Links to further documentation -->
index b9f3878..b507e18 100644 (file)
@@ -15,6 +15,7 @@
 ## How to Use
 
 <!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
+
 ```C#
 using Microsoft.Extensions.Configuration;
 
index 563660c..202fb6d 100644 (file)
@@ -6,14 +6,6 @@ This package provides collections that are thread safe and guaranteed to never c
 
 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.
 
-## Key Features
-
-<!-- The key features of this package -->
-
-*
-*
-*
-
 ## How to Use
 
 <!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
index df290dd..9215061 100644 (file)
@@ -83,9 +83,11 @@ class Program
 
 The main types provided by this library are:
 
-* ``
-* ``
-* ``
+* `System.Reflection.Metadata.MetadataReader`
+* `System.Reflection.PortableExecutable.PEReader`
+* `System.Reflection.Metadata.Ecma335.MetadataBuilder`
+* `System.Reflection.PortableExecutable.PEBuilder`
+* `System.Reflection.PortableExecutable.ManagedPEBuilder`
 
 ## Additional Documentation
 
@@ -97,10 +99,6 @@ The main types provided by this library are:
 * [System.Reflection.PortableExecutable.PEBuilder](https://docs.microsoft.com/dotnet/api/system.reflection.portableexecutable.pebuilder)
 * [System.Reflection.PortableExecutable.ManagedPEBuilder](https://docs.microsoft.com/dotnet/api/system.reflection.portableexecutable.managedpebuilder)
 
-## Related Packages
-
-<!-- The related packages associated with this package -->
-
 ## Feedback & Contributing
 
 <!-- How to provide feedback on this package and contribute to it -->