From f4d8115023913918811c156305ee953422aa5b72 Mon Sep 17 00:00:00 2001 From: Viktor Hofer Date: Mon, 18 Sep 2023 17:02:13 +0200 Subject: [PATCH 01/23] Initialize package readmes --- .../Microsoft.Bcl.Cryptography/src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ src/libraries/System.CodeDom/src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../System.Composition.Hosting/src/PACKAGE.md | 44 +++++++++++++++++++ .../System.Composition.Runtime/src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../System.Composition/src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../System.Formats.Cbor/src/PACKAGE.md | 44 +++++++++++++++++++ .../System.IO.Hashing/src/PACKAGE.md | 44 +++++++++++++++++++ .../System.IO.Packaging/src/PACKAGE.md | 44 +++++++++++++++++++ .../System.IO.Pipelines/src/PACKAGE.md | 44 +++++++++++++++++++ .../System.Memory.Data/src/PACKAGE.md | 44 +++++++++++++++++++ .../System.Numerics.Tensors/src/PACKAGE.md | 44 +++++++++++++++++++ .../System.Reflection.Context/src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../System.Text.Encodings.Web/src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../src/PACKAGE.md | 44 +++++++++++++++++++ .../System.Windows.Extensions/src/PACKAGE.md | 44 +++++++++++++++++++ 47 files changed, 2068 insertions(+) create mode 100644 src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md create mode 100644 src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PACKAGE.md create mode 100644 src/libraries/Microsoft.Extensions.DependencyInjection.Specification.Tests/src/PACKAGE.md create mode 100644 src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/PACKAGE.md create mode 100644 src/libraries/Microsoft.Extensions.FileProviders.Composite/src/PACKAGE.md create mode 100644 src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PACKAGE.md create mode 100644 src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md create mode 100644 src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md create mode 100644 src/libraries/Microsoft.Extensions.Logging.Configuration/src/PACKAGE.md create mode 100644 src/libraries/Microsoft.Extensions.Logging.EventSource/src/PACKAGE.md create mode 100644 src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md create mode 100644 src/libraries/Microsoft.Extensions.Options.DataAnnotations/src/PACKAGE.md create mode 100644 src/libraries/Microsoft.NET.WebAssembly.Threading/src/PACKAGE.md create mode 100644 src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md create mode 100644 src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md create mode 100644 src/libraries/Microsoft.XmlSerializer.Generator/src/PACKAGE.md create mode 100644 src/libraries/System.CodeDom/src/PACKAGE.md create mode 100644 src/libraries/System.ComponentModel.Composition.Registration/src/PACKAGE.md create mode 100644 src/libraries/System.ComponentModel.Composition/src/PACKAGE.md create mode 100644 src/libraries/System.Composition.AttributedModel/src/PACKAGE.md create mode 100644 src/libraries/System.Composition.Convention/src/PACKAGE.md create mode 100644 src/libraries/System.Composition.Hosting/src/PACKAGE.md create mode 100644 src/libraries/System.Composition.Runtime/src/PACKAGE.md create mode 100644 src/libraries/System.Composition.TypedParts/src/PACKAGE.md create mode 100644 src/libraries/System.Composition/src/PACKAGE.md create mode 100644 src/libraries/System.Diagnostics.DiagnosticSource/src/PACKAGE.md create mode 100644 src/libraries/System.DirectoryServices.Protocols/src/PACKAGE.md create mode 100644 src/libraries/System.Formats.Cbor/src/PACKAGE.md create mode 100644 src/libraries/System.IO.Hashing/src/PACKAGE.md create mode 100644 src/libraries/System.IO.Packaging/src/PACKAGE.md create mode 100644 src/libraries/System.IO.Pipelines/src/PACKAGE.md create mode 100644 src/libraries/System.Memory.Data/src/PACKAGE.md create mode 100644 src/libraries/System.Numerics.Tensors/src/PACKAGE.md create mode 100644 src/libraries/System.Reflection.Context/src/PACKAGE.md create mode 100644 src/libraries/System.Resources.Extensions/src/PACKAGE.md create mode 100644 src/libraries/System.Runtime.Serialization.Schema/src/PACKAGE.md create mode 100644 src/libraries/System.Security.Cryptography.Cose/src/PACKAGE.md create mode 100644 src/libraries/System.Security.Cryptography.Pkcs/src/PACKAGE.md create mode 100644 src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md create mode 100644 src/libraries/System.Security.Cryptography.Xml/src/PACKAGE.md create mode 100644 src/libraries/System.Security.Permissions/src/PACKAGE.md create mode 100644 src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md create mode 100644 src/libraries/System.Text.Encodings.Web/src/PACKAGE.md create mode 100644 src/libraries/System.Threading.AccessControl/src/PACKAGE.md create mode 100644 src/libraries/System.Threading.RateLimiting/src/PACKAGE.md create mode 100644 src/libraries/System.Threading.Tasks.Dataflow/src/PACKAGE.md create mode 100644 src/libraries/System.Windows.Extensions/src/PACKAGE.md diff --git a/src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md b/src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md new file mode 100644 index 0000000000000..df639a6cc1647 --- /dev/null +++ b/src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.Bcl.Cryptography is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PACKAGE.md new file mode 100644 index 0000000000000..06c9f1bee029a --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.Extensions.Caching.Abstractions is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/Microsoft.Extensions.DependencyInjection.Specification.Tests/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.DependencyInjection.Specification.Tests/src/PACKAGE.md new file mode 100644 index 0000000000000..74ad997aae423 --- /dev/null +++ b/src/libraries/Microsoft.Extensions.DependencyInjection.Specification.Tests/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.Extensions.DependencyInjection.Specification.Tests is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/PACKAGE.md new file mode 100644 index 0000000000000..cf96b327b1cf9 --- /dev/null +++ b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.Extensions.FileProviders.Abstractions is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/PACKAGE.md new file mode 100644 index 0000000000000..f0d2c3ffecb22 --- /dev/null +++ b/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.Extensions.FileProviders.Composite is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PACKAGE.md new file mode 100644 index 0000000000000..2857ab5e67878 --- /dev/null +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.Extensions.FileProviders.Physical is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md new file mode 100644 index 0000000000000..9e3801f758a08 --- /dev/null +++ b/src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.Extensions.FileSystemGlobbing is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md new file mode 100644 index 0000000000000..0f9358494ba74 --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.Extensions.Hosting.Systemd is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/Microsoft.Extensions.Logging.Configuration/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Logging.Configuration/src/PACKAGE.md new file mode 100644 index 0000000000000..ecfe712b7012c --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Logging.Configuration/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.Extensions.Logging.Configuration is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/Microsoft.Extensions.Logging.EventSource/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/PACKAGE.md new file mode 100644 index 0000000000000..3e3ea25e38e97 --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.Extensions.Logging.EventSource is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md new file mode 100644 index 0000000000000..44df455dbcd1c --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.Extensions.Logging.TraceSource is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/Microsoft.Extensions.Options.DataAnnotations/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Options.DataAnnotations/src/PACKAGE.md new file mode 100644 index 0000000000000..66b8bc76efc55 --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Options.DataAnnotations/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.Extensions.Options.DataAnnotations is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/Microsoft.NET.WebAssembly.Threading/src/PACKAGE.md b/src/libraries/Microsoft.NET.WebAssembly.Threading/src/PACKAGE.md new file mode 100644 index 0000000000000..f392d7f5c1da8 --- /dev/null +++ b/src/libraries/Microsoft.NET.WebAssembly.Threading/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.NET.WebAssembly.Threading is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md b/src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md new file mode 100644 index 0000000000000..ada4ea27b6530 --- /dev/null +++ b/src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.Win32.Registry.AccessControl is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md b/src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md new file mode 100644 index 0000000000000..20049fb3788f8 --- /dev/null +++ b/src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.Win32.SystemEvents is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/Microsoft.XmlSerializer.Generator/src/PACKAGE.md b/src/libraries/Microsoft.XmlSerializer.Generator/src/PACKAGE.md new file mode 100644 index 0000000000000..3881bbb005ffa --- /dev/null +++ b/src/libraries/Microsoft.XmlSerializer.Generator/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +Microsoft.XmlSerializer.Generator is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.CodeDom/src/PACKAGE.md b/src/libraries/System.CodeDom/src/PACKAGE.md new file mode 100644 index 0000000000000..8d0fbc5872574 --- /dev/null +++ b/src/libraries/System.CodeDom/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.CodeDom is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.ComponentModel.Composition.Registration/src/PACKAGE.md b/src/libraries/System.ComponentModel.Composition.Registration/src/PACKAGE.md new file mode 100644 index 0000000000000..eba3a44e0e178 --- /dev/null +++ b/src/libraries/System.ComponentModel.Composition.Registration/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.ComponentModel.Composition.Registration is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.ComponentModel.Composition/src/PACKAGE.md b/src/libraries/System.ComponentModel.Composition/src/PACKAGE.md new file mode 100644 index 0000000000000..f91a8363665d1 --- /dev/null +++ b/src/libraries/System.ComponentModel.Composition/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.ComponentModel.Composition is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Composition.AttributedModel/src/PACKAGE.md b/src/libraries/System.Composition.AttributedModel/src/PACKAGE.md new file mode 100644 index 0000000000000..fa20133ba6a86 --- /dev/null +++ b/src/libraries/System.Composition.AttributedModel/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Composition.AttributedModel is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Composition.Convention/src/PACKAGE.md b/src/libraries/System.Composition.Convention/src/PACKAGE.md new file mode 100644 index 0000000000000..a6486dee287c1 --- /dev/null +++ b/src/libraries/System.Composition.Convention/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Composition.Convention is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Composition.Hosting/src/PACKAGE.md b/src/libraries/System.Composition.Hosting/src/PACKAGE.md new file mode 100644 index 0000000000000..65273363edc92 --- /dev/null +++ b/src/libraries/System.Composition.Hosting/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Composition.Hosting is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Composition.Runtime/src/PACKAGE.md b/src/libraries/System.Composition.Runtime/src/PACKAGE.md new file mode 100644 index 0000000000000..d0b11f40ae387 --- /dev/null +++ b/src/libraries/System.Composition.Runtime/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Composition.Runtime is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Composition.TypedParts/src/PACKAGE.md b/src/libraries/System.Composition.TypedParts/src/PACKAGE.md new file mode 100644 index 0000000000000..8f1234fe5eb7e --- /dev/null +++ b/src/libraries/System.Composition.TypedParts/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Composition.TypedParts is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Composition/src/PACKAGE.md b/src/libraries/System.Composition/src/PACKAGE.md new file mode 100644 index 0000000000000..aed1bb67a2652 --- /dev/null +++ b/src/libraries/System.Composition/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Composition is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Diagnostics.DiagnosticSource/src/PACKAGE.md b/src/libraries/System.Diagnostics.DiagnosticSource/src/PACKAGE.md new file mode 100644 index 0000000000000..dd721a9688da5 --- /dev/null +++ b/src/libraries/System.Diagnostics.DiagnosticSource/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Diagnostics.DiagnosticSource is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.DirectoryServices.Protocols/src/PACKAGE.md b/src/libraries/System.DirectoryServices.Protocols/src/PACKAGE.md new file mode 100644 index 0000000000000..c06e75e48ae1e --- /dev/null +++ b/src/libraries/System.DirectoryServices.Protocols/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.DirectoryServices.Protocols is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Formats.Cbor/src/PACKAGE.md b/src/libraries/System.Formats.Cbor/src/PACKAGE.md new file mode 100644 index 0000000000000..96474955ed1b1 --- /dev/null +++ b/src/libraries/System.Formats.Cbor/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Formats.Cbor is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.IO.Hashing/src/PACKAGE.md b/src/libraries/System.IO.Hashing/src/PACKAGE.md new file mode 100644 index 0000000000000..9e6719c28fd4a --- /dev/null +++ b/src/libraries/System.IO.Hashing/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.IO.Hashing is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.IO.Packaging/src/PACKAGE.md b/src/libraries/System.IO.Packaging/src/PACKAGE.md new file mode 100644 index 0000000000000..f3cbe0ec77412 --- /dev/null +++ b/src/libraries/System.IO.Packaging/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.IO.Packaging is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.IO.Pipelines/src/PACKAGE.md b/src/libraries/System.IO.Pipelines/src/PACKAGE.md new file mode 100644 index 0000000000000..07b76a5a6e0bb --- /dev/null +++ b/src/libraries/System.IO.Pipelines/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.IO.Pipelines is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Memory.Data/src/PACKAGE.md b/src/libraries/System.Memory.Data/src/PACKAGE.md new file mode 100644 index 0000000000000..a41bbe80d1089 --- /dev/null +++ b/src/libraries/System.Memory.Data/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Memory.Data is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Numerics.Tensors/src/PACKAGE.md b/src/libraries/System.Numerics.Tensors/src/PACKAGE.md new file mode 100644 index 0000000000000..3959650cfacd5 --- /dev/null +++ b/src/libraries/System.Numerics.Tensors/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Numerics.Tensors is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Reflection.Context/src/PACKAGE.md b/src/libraries/System.Reflection.Context/src/PACKAGE.md new file mode 100644 index 0000000000000..6b3ea0dccc6e9 --- /dev/null +++ b/src/libraries/System.Reflection.Context/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Reflection.Context is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Resources.Extensions/src/PACKAGE.md b/src/libraries/System.Resources.Extensions/src/PACKAGE.md new file mode 100644 index 0000000000000..bc740503b6c4f --- /dev/null +++ b/src/libraries/System.Resources.Extensions/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Resources.Extensions is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Runtime.Serialization.Schema/src/PACKAGE.md b/src/libraries/System.Runtime.Serialization.Schema/src/PACKAGE.md new file mode 100644 index 0000000000000..32703b7a9171e --- /dev/null +++ b/src/libraries/System.Runtime.Serialization.Schema/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Runtime.Serialization.Schema is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Security.Cryptography.Cose/src/PACKAGE.md b/src/libraries/System.Security.Cryptography.Cose/src/PACKAGE.md new file mode 100644 index 0000000000000..c07b43e1d8978 --- /dev/null +++ b/src/libraries/System.Security.Cryptography.Cose/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Security.Cryptography.Cose is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Security.Cryptography.Pkcs/src/PACKAGE.md b/src/libraries/System.Security.Cryptography.Pkcs/src/PACKAGE.md new file mode 100644 index 0000000000000..c6b169ef2a5f9 --- /dev/null +++ b/src/libraries/System.Security.Cryptography.Pkcs/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Security.Cryptography.Pkcs is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md b/src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md new file mode 100644 index 0000000000000..3540bcfc25384 --- /dev/null +++ b/src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Security.Cryptography.ProtectedData is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Security.Cryptography.Xml/src/PACKAGE.md b/src/libraries/System.Security.Cryptography.Xml/src/PACKAGE.md new file mode 100644 index 0000000000000..66dd9122df501 --- /dev/null +++ b/src/libraries/System.Security.Cryptography.Xml/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Security.Cryptography.Xml is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Security.Permissions/src/PACKAGE.md b/src/libraries/System.Security.Permissions/src/PACKAGE.md new file mode 100644 index 0000000000000..42702c77c66c4 --- /dev/null +++ b/src/libraries/System.Security.Permissions/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Security.Permissions is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md b/src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md new file mode 100644 index 0000000000000..1fc03ca6f9007 --- /dev/null +++ b/src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.ServiceModel.Syndication is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Text.Encodings.Web/src/PACKAGE.md b/src/libraries/System.Text.Encodings.Web/src/PACKAGE.md new file mode 100644 index 0000000000000..b052cd5f92a26 --- /dev/null +++ b/src/libraries/System.Text.Encodings.Web/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Text.Encodings.Web is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Threading.AccessControl/src/PACKAGE.md b/src/libraries/System.Threading.AccessControl/src/PACKAGE.md new file mode 100644 index 0000000000000..ac3658ca62f32 --- /dev/null +++ b/src/libraries/System.Threading.AccessControl/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Threading.AccessControl is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Threading.RateLimiting/src/PACKAGE.md b/src/libraries/System.Threading.RateLimiting/src/PACKAGE.md new file mode 100644 index 0000000000000..72a0f2a9bc8d9 --- /dev/null +++ b/src/libraries/System.Threading.RateLimiting/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Threading.RateLimiting is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Threading.Tasks.Dataflow/src/PACKAGE.md b/src/libraries/System.Threading.Tasks.Dataflow/src/PACKAGE.md new file mode 100644 index 0000000000000..d435316b7785b --- /dev/null +++ b/src/libraries/System.Threading.Tasks.Dataflow/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Threading.Tasks.Dataflow is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file diff --git a/src/libraries/System.Windows.Extensions/src/PACKAGE.md b/src/libraries/System.Windows.Extensions/src/PACKAGE.md new file mode 100644 index 0000000000000..90d18f7b5643e --- /dev/null +++ b/src/libraries/System.Windows.Extensions/src/PACKAGE.md @@ -0,0 +1,44 @@ +## About + + + + + +## Key Features + + + +* +* +* + +## How to Use + + + +## Main Types + + + +The main types provided by this library are: + +* `` +* `` +* `` + +## Addtional Documentation + + + +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) + +## Related Packages + + + +## Feedback & Contributing + + + +System.Windows.Extensions is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file From b608c28fe8c1237ea013719b540093fb6770b3eb Mon Sep 17 00:00:00 2001 From: Illia Larka Date: Tue, 3 Oct 2023 23:01:12 +0200 Subject: [PATCH 02/23] Microsoft.Extensions.Logging.TraceSource package readme update (#92962) Fix #92228 --- .../src/PACKAGE.md | 49 +++++++++++++++---- 1 file changed, 40 insertions(+), 9 deletions(-) diff --git a/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md index 44df455dbcd1c..db6f1de26e6c4 100644 --- a/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md @@ -2,41 +2,72 @@ - +Implements a trace logger provider for the .NET logging infrastructre facilitating enhanced logging capabilities and trace-level diagnostics in application by writing messages to a trace listener using System.Diagnostic.TraceSource. ## Key Features -* -* -* +* Seamless integration with .NET logging infrastructure. +* Fine-grained control over trace messages using SourceSwitch. +* A set of builder methods to configure logging infrastructure. ## How to Use +The Microsoft.Extensions.Logging.TraceSource library provides extension methods to the logger factory and the logger builder to add a trace source with trace listeners. + +```csharp +using System.Diagnostics; +using Microsoft.Extensions.Logging; + +using var consoleTraceListener = new ConsoleTraceListener(); +using var textWriterTraceListener = new TextWriterTraceListener("/traces.txt"); +using var loggerFactory = LoggerFactory.Create(builder => +{ + builder + .AddTraceSource(new SourceSwitch("Something") { Level = SourceLevels.All }, consoleTraceListener) + .AddTraceSource(new SourceSwitch("HouseKeeping") { Level = SourceLevels.All }, textWriterTraceListener); +}); + +var logger = loggerFactory.CreateLogger(); + +logger.LogInformation("Information message."); +// Program Information: 0 : Information message. +logger.LogWarning("Warning message."); +// Program Warning: 0 : Warning message. + +var traceSource = new TraceSource("HouseKeeping", SourceLevels.All); +traceSource.Listeners.Add(consoleTraceListener); +traceSource.Listeners.Add(textWriterTraceListener); + +traceSource.TraceEvent(TraceEventType.Error, 0, "Error message."); +//HouseKeeping Error: 0 : Error message. +``` + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `Microsoft.Extensions.Logging.TraceSource.TraceSourceLoggerProvider` ## Addtional Documentation -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.tracesource) ## Related Packages +* Abstractions for dependency injection: [Microsoft.Extensions.DependencyInjection.Abstractions](https://www.nuget.org/packages/Microsoft.Extensions.DependencyInjection.Abstractions/) +* Defult implementation of logging infrastructure: [Microsoft.Extensions.Logging](https://www.nuget.org/packages/Microsoft.Extensions.Logging/) +* Abstractions for logging: [Microsoft.Extensions.Logging.Abstractions](https://www.nuget.org/packages/Microsoft.Extensions.Logging.Abstractions/) + ## Feedback & Contributing From 5ab4d08f05e560420431ca8a431b426d1a2f8afa Mon Sep 17 00:00:00 2001 From: Illia Larka Date: Wed, 4 Oct 2023 11:46:03 +0200 Subject: [PATCH 03/23] Fix PACKAGE.md typo (#92989) Typo in word 'Defult' fixed to 'Default'. Fix #92228 --- .../Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md index db6f1de26e6c4..f19aa7adb5f9f 100644 --- a/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md @@ -65,7 +65,7 @@ The main types provided by this library are: * Abstractions for dependency injection: [Microsoft.Extensions.DependencyInjection.Abstractions](https://www.nuget.org/packages/Microsoft.Extensions.DependencyInjection.Abstractions/) -* Defult implementation of logging infrastructure: [Microsoft.Extensions.Logging](https://www.nuget.org/packages/Microsoft.Extensions.Logging/) +* Default implementation of logging infrastructure: [Microsoft.Extensions.Logging](https://www.nuget.org/packages/Microsoft.Extensions.Logging/) * Abstractions for logging: [Microsoft.Extensions.Logging.Abstractions](https://www.nuget.org/packages/Microsoft.Extensions.Logging.Abstractions/) ## Feedback & Contributing From 8a165a5941f2aaf57ae660e40507a79a349d07a7 Mon Sep 17 00:00:00 2001 From: Kevin Jones Date: Wed, 4 Oct 2023 12:26:19 -0400 Subject: [PATCH 04/23] Update Microsoft.Bcl.Cryptography/src/PACKAGE.md --- .../Microsoft.Bcl.Cryptography/src/PACKAGE.md | 45 +++++++++---------- 1 file changed, 20 insertions(+), 25 deletions(-) diff --git a/src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md b/src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md index df639a6cc1647..8b19311f0a7cd 100644 --- a/src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md +++ b/src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md @@ -1,44 +1,39 @@ ## About - - - +This library provides some cryptographic types and functionality for .NET Standard and .NET Framework. This library is not necessary nor recommended when targeting versions of .NET that include the relevant support. ## Key Features - - -* -* -* +* Enables the use of some cryptographic functionality on older .NET platforms. ## How to Use - +This package should only be used by platforms where the desired functionality is not built-in. -## Main Types +```C# +using System.Security.Cryptography; + +internal static class Program +{ + private static void Main() + { + byte[] key = LoadKey(); + SP800108HmacCounterKdf kbkdf = new(key, HashAlgorithmName.SHA256); + byte[] derivedKey = kbkdf.DeriveKey("label"u8, "context"u8, derivedKeyLengthInBytes: 32); + } +} +``` - +## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `System.Security.Cryptography.SP800108HmacCounterKdf` ## Addtional Documentation - - -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) - -## Related Packages - - +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/System.Security.Cryptography) ## Feedback & Contributing - - -Microsoft.Bcl.Cryptography is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +Microsoft.Bcl.Cryptography is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). From 37120cdcd90b79d5dbdf168354d9d4db27058fab Mon Sep 17 00:00:00 2001 From: Illia Larka Date: Mon, 9 Oct 2023 10:56:12 +0200 Subject: [PATCH 05/23] System.Formats.Cbor package's readme (#93021) * Remove conceptual docummentation item Removed since is not applicable * List types library provides Add list of types which library provides. Listed public types, means exposed types. * Add description and usage examples Add library description. Add few code examples showing basic functionality for CBOR wirter and reader types. * Add related packages section Since different targets have different dependencies so I have divided for each section. * Improve short description Add 'format' word after abbreviation to have an object in sentence. * Remove related packages section Since there are no related packages. * Improve array reading/writing example --- .../System.Formats.Cbor/src/PACKAGE.md | 77 +++++++++++++++---- 1 file changed, 64 insertions(+), 13 deletions(-) diff --git a/src/libraries/System.Formats.Cbor/src/PACKAGE.md b/src/libraries/System.Formats.Cbor/src/PACKAGE.md index 96474955ed1b1..ff26f0debbdc0 100644 --- a/src/libraries/System.Formats.Cbor/src/PACKAGE.md +++ b/src/libraries/System.Formats.Cbor/src/PACKAGE.md @@ -2,40 +2,91 @@ +Provides support for reading and writing values in Concise Binary Object Representation (CBOR) format, as originally defined in [IETF RFC 7049](https://www.ietf.org/rfc/rfc7049.html). ## Key Features -* -* -* +* Reader and writer types for the CBOR format. +* Built-in support for different CBOR conformance modes. ## How to Use +Write and read primitives: + +```csharp +using System.Formats.Cbor; + +var cborWriter = new CborWriter(CborConformanceMode.Lax); +cborWriter.WriteTextString("Hello World"); + +var cborReader = new CborReader(cborWriter.Encode(), CborConformanceMode.Lax); +Console.WriteLine(cborReader.ReadTextString()); +// Hello World +``` + +Write and read an array: + +```csharp +var cborWriter = new CborWriter(CborConformanceMode.Lax); +cborWriter.WriteStartArray(5); +for (var index = 0; index < 5; index++) +{ + cborWriter.WriteInt32(index); +} +cborWriter.WriteEndArray(); + +var cborReader = new CborReader(cborWriter.Encode(), CborConformanceMode.Lax); +var arrayLength = cborReader.ReadStartArray(); +for (var index = 0; index < arrayLength; index++) +{ + Console.Write(cborReader.ReadInt32()); +} +// 01234 +cborReader.ReadEndArray(); +``` + +Inspect writer and reader state: + +```csharp +var cborWriter = new CborWriter(CborConformanceMode.Lax); +cborWriter.WriteTextString("SomeArray"); +Console.WriteLine(cborWriter.BytesWritten); +// 10 +Console.WriteLine(cborWriter.IsWriteCompleted); +// True + +var cborReader = new CborReader(cborWriter.Encode(), CborConformanceMode.Lax); +Console.WriteLine(cborReader.BytesRemaining); +// 10 +Console.WriteLine(cborReader.ReadTextString()); +// SomeArray +Console.WriteLine(cborReader.BytesRemaining); +// 0 +``` + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `System.Formats.Cbor.CborReader` +* `System.Formats.Cbor.CborWriter` +* `System.Formats.Cbor.CborReaderState` +* `System.Formats.Cbor.CborConformanceMode` +* `System.Formats.Cbor.CborContentException` +* `System.Formats.Cbor.CborTag` -## Addtional Documentation +## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) - -## Related Packages - - +* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/system.formats.cbor) ## Feedback & Contributing From 80426d89847d43fa0a7a39730af3002b008b9628 Mon Sep 17 00:00:00 2001 From: Logan Payton <18620874+EnsignPayton@users.noreply.github.com> Date: Mon, 9 Oct 2023 03:59:47 -0500 Subject: [PATCH 06/23] Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (#93123) * Microsoft.Extensions.FileSystemGlobbing PACKAGE.md Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet package readme See https://github.com/dotnet/runtime/pull/92228 * Update src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md * Update src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md --------- Co-authored-by: Viktor Hofer --- .../src/PACKAGE.md | 36 +++++++++++-------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md index 9e3801f758a08..433fa943e1172 100644 --- a/src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md @@ -2,40 +2,48 @@ - +Provides support for matching file system names/paths using [glob patterns](https://en.wikipedia.org/wiki/Glob_(programming)). ## Key Features -* -* -* +* Contains the `Matcher` type, which can be used to match files in the file system based on user-defined patterns. ## How to Use +Get all matching files: + +```c# +using Microsoft.Extensions.FileSystemGlobbing; + +Matcher matcher = new(); +matcher.AddIncludePatterns(new[] { "*.txt", "*.asciidoc", "*.md" }); + +string searchDirectory = "../starting-folder/"; + +IEnumerable matchingFiles = matcher.GetResultsInFullPath(searchDirectory); + +// Use matchingFiles if there are any found. +// The files in this collection are fully qualified file system paths. +``` + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `Microsoft.Extensions.FileSystemGlobbing.Matcher` -## Addtional Documentation +## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) - -## Related Packages - - +* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/core/extensions/file-globbing) +* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.filesystemglobbing) ## Feedback & Contributing From 0db2545b283870fd1337f12084e78fe5a658a7a4 Mon Sep 17 00:00:00 2001 From: Viktor Hofer Date: Mon, 9 Oct 2023 09:04:24 +0000 Subject: [PATCH 07/23] Fix typo in package readmes --- src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md | 2 +- .../Microsoft.Extensions.Caching.Abstractions/src/PACKAGE.md | 2 +- .../src/PACKAGE.md | 2 +- .../src/PACKAGE.md | 2 +- .../Microsoft.Extensions.FileProviders.Composite/src/PACKAGE.md | 2 +- .../Microsoft.Extensions.FileProviders.Physical/src/PACKAGE.md | 2 +- .../Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md | 2 +- .../Microsoft.Extensions.Logging.Configuration/src/PACKAGE.md | 2 +- .../Microsoft.Extensions.Logging.EventSource/src/PACKAGE.md | 2 +- .../Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md | 2 +- .../Microsoft.Extensions.Options.DataAnnotations/src/PACKAGE.md | 2 +- .../Microsoft.NET.WebAssembly.Threading/src/PACKAGE.md | 2 +- .../Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md | 2 +- src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md | 2 +- src/libraries/Microsoft.XmlSerializer.Generator/src/PACKAGE.md | 2 +- src/libraries/System.CodeDom/src/PACKAGE.md | 2 +- .../src/PACKAGE.md | 2 +- src/libraries/System.ComponentModel.Composition/src/PACKAGE.md | 2 +- src/libraries/System.Composition.AttributedModel/src/PACKAGE.md | 2 +- src/libraries/System.Composition.Convention/src/PACKAGE.md | 2 +- src/libraries/System.Composition.Hosting/src/PACKAGE.md | 2 +- src/libraries/System.Composition.Runtime/src/PACKAGE.md | 2 +- src/libraries/System.Composition.TypedParts/src/PACKAGE.md | 2 +- src/libraries/System.Composition/src/PACKAGE.md | 2 +- .../System.Diagnostics.DiagnosticSource/src/PACKAGE.md | 2 +- src/libraries/System.DirectoryServices.Protocols/src/PACKAGE.md | 2 +- src/libraries/System.IO.Hashing/src/PACKAGE.md | 2 +- src/libraries/System.IO.Packaging/src/PACKAGE.md | 2 +- src/libraries/System.IO.Pipelines/src/PACKAGE.md | 2 +- src/libraries/System.Memory.Data/src/PACKAGE.md | 2 +- src/libraries/System.Numerics.Tensors/src/PACKAGE.md | 2 +- src/libraries/System.Reflection.Context/src/PACKAGE.md | 2 +- src/libraries/System.Resources.Extensions/src/PACKAGE.md | 2 +- .../System.Runtime.Serialization.Schema/src/PACKAGE.md | 2 +- src/libraries/System.Security.Cryptography.Cose/src/PACKAGE.md | 2 +- src/libraries/System.Security.Cryptography.Pkcs/src/PACKAGE.md | 2 +- .../System.Security.Cryptography.ProtectedData/src/PACKAGE.md | 2 +- src/libraries/System.Security.Cryptography.Xml/src/PACKAGE.md | 2 +- src/libraries/System.Security.Permissions/src/PACKAGE.md | 2 +- src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md | 2 +- src/libraries/System.Text.Encodings.Web/src/PACKAGE.md | 2 +- src/libraries/System.Threading.AccessControl/src/PACKAGE.md | 2 +- src/libraries/System.Threading.RateLimiting/src/PACKAGE.md | 2 +- src/libraries/System.Threading.Tasks.Dataflow/src/PACKAGE.md | 2 +- src/libraries/System.Windows.Extensions/src/PACKAGE.md | 2 +- 45 files changed, 45 insertions(+), 45 deletions(-) diff --git a/src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md b/src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md index 8b19311f0a7cd..4346252b24386 100644 --- a/src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md +++ b/src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md @@ -30,7 +30,7 @@ The main types provided by this library are: * `System.Security.Cryptography.SP800108HmacCounterKdf` -## Addtional Documentation +## Additional Documentation * [API documentation](https://learn.microsoft.com/en-us/dotnet/api/System.Security.Cryptography) diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PACKAGE.md index 06c9f1bee029a..651e3c04c9840 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/Microsoft.Extensions.DependencyInjection.Specification.Tests/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.DependencyInjection.Specification.Tests/src/PACKAGE.md index 74ad997aae423..79b5aea01302e 100644 --- a/src/libraries/Microsoft.Extensions.DependencyInjection.Specification.Tests/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.DependencyInjection.Specification.Tests/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/PACKAGE.md index cf96b327b1cf9..efb7ca7c9133c 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/PACKAGE.md index f0d2c3ffecb22..122fbecfa2ba9 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PACKAGE.md index 2857ab5e67878..bf3378a56e63d 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md index 0f9358494ba74..ffb5501c8568f 100644 --- a/src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/Microsoft.Extensions.Logging.Configuration/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Logging.Configuration/src/PACKAGE.md index ecfe712b7012c..7c38fc44d350f 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Configuration/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.Logging.Configuration/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/Microsoft.Extensions.Logging.EventSource/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/PACKAGE.md index 3e3ea25e38e97..8a67a2888f46d 100644 --- a/src/libraries/Microsoft.Extensions.Logging.EventSource/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md index f19aa7adb5f9f..25abc578ba6d3 100644 --- a/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md @@ -54,7 +54,7 @@ The main types provided by this library are: * `Microsoft.Extensions.Logging.TraceSource.TraceSourceLoggerProvider` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/Microsoft.Extensions.Options.DataAnnotations/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Options.DataAnnotations/src/PACKAGE.md index 66b8bc76efc55..3bf3280ad4cf1 100644 --- a/src/libraries/Microsoft.Extensions.Options.DataAnnotations/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.Options.DataAnnotations/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/Microsoft.NET.WebAssembly.Threading/src/PACKAGE.md b/src/libraries/Microsoft.NET.WebAssembly.Threading/src/PACKAGE.md index f392d7f5c1da8..009758b7e5f78 100644 --- a/src/libraries/Microsoft.NET.WebAssembly.Threading/src/PACKAGE.md +++ b/src/libraries/Microsoft.NET.WebAssembly.Threading/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md b/src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md index ada4ea27b6530..f74e2de2b1ea3 100644 --- a/src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md +++ b/src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md b/src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md index 20049fb3788f8..4d4256fedf744 100644 --- a/src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md +++ b/src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/Microsoft.XmlSerializer.Generator/src/PACKAGE.md b/src/libraries/Microsoft.XmlSerializer.Generator/src/PACKAGE.md index 3881bbb005ffa..b83986018d2e7 100644 --- a/src/libraries/Microsoft.XmlSerializer.Generator/src/PACKAGE.md +++ b/src/libraries/Microsoft.XmlSerializer.Generator/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.CodeDom/src/PACKAGE.md b/src/libraries/System.CodeDom/src/PACKAGE.md index 8d0fbc5872574..259e0feb50cec 100644 --- a/src/libraries/System.CodeDom/src/PACKAGE.md +++ b/src/libraries/System.CodeDom/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.ComponentModel.Composition.Registration/src/PACKAGE.md b/src/libraries/System.ComponentModel.Composition.Registration/src/PACKAGE.md index eba3a44e0e178..2fa0eb6196f3c 100644 --- a/src/libraries/System.ComponentModel.Composition.Registration/src/PACKAGE.md +++ b/src/libraries/System.ComponentModel.Composition.Registration/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.ComponentModel.Composition/src/PACKAGE.md b/src/libraries/System.ComponentModel.Composition/src/PACKAGE.md index f91a8363665d1..0096b2acdca3f 100644 --- a/src/libraries/System.ComponentModel.Composition/src/PACKAGE.md +++ b/src/libraries/System.ComponentModel.Composition/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Composition.AttributedModel/src/PACKAGE.md b/src/libraries/System.Composition.AttributedModel/src/PACKAGE.md index fa20133ba6a86..1f533435c4b86 100644 --- a/src/libraries/System.Composition.AttributedModel/src/PACKAGE.md +++ b/src/libraries/System.Composition.AttributedModel/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Composition.Convention/src/PACKAGE.md b/src/libraries/System.Composition.Convention/src/PACKAGE.md index a6486dee287c1..8cad9d889483b 100644 --- a/src/libraries/System.Composition.Convention/src/PACKAGE.md +++ b/src/libraries/System.Composition.Convention/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Composition.Hosting/src/PACKAGE.md b/src/libraries/System.Composition.Hosting/src/PACKAGE.md index 65273363edc92..be4b5f096e0e0 100644 --- a/src/libraries/System.Composition.Hosting/src/PACKAGE.md +++ b/src/libraries/System.Composition.Hosting/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Composition.Runtime/src/PACKAGE.md b/src/libraries/System.Composition.Runtime/src/PACKAGE.md index d0b11f40ae387..3e30bc15c6832 100644 --- a/src/libraries/System.Composition.Runtime/src/PACKAGE.md +++ b/src/libraries/System.Composition.Runtime/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Composition.TypedParts/src/PACKAGE.md b/src/libraries/System.Composition.TypedParts/src/PACKAGE.md index 8f1234fe5eb7e..cf5a4d1cb02ed 100644 --- a/src/libraries/System.Composition.TypedParts/src/PACKAGE.md +++ b/src/libraries/System.Composition.TypedParts/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Composition/src/PACKAGE.md b/src/libraries/System.Composition/src/PACKAGE.md index aed1bb67a2652..33a8905040b5f 100644 --- a/src/libraries/System.Composition/src/PACKAGE.md +++ b/src/libraries/System.Composition/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Diagnostics.DiagnosticSource/src/PACKAGE.md b/src/libraries/System.Diagnostics.DiagnosticSource/src/PACKAGE.md index dd721a9688da5..69b5def89a51c 100644 --- a/src/libraries/System.Diagnostics.DiagnosticSource/src/PACKAGE.md +++ b/src/libraries/System.Diagnostics.DiagnosticSource/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.DirectoryServices.Protocols/src/PACKAGE.md b/src/libraries/System.DirectoryServices.Protocols/src/PACKAGE.md index c06e75e48ae1e..61bbd897786b2 100644 --- a/src/libraries/System.DirectoryServices.Protocols/src/PACKAGE.md +++ b/src/libraries/System.DirectoryServices.Protocols/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.IO.Hashing/src/PACKAGE.md b/src/libraries/System.IO.Hashing/src/PACKAGE.md index 9e6719c28fd4a..5bb2b57175907 100644 --- a/src/libraries/System.IO.Hashing/src/PACKAGE.md +++ b/src/libraries/System.IO.Hashing/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.IO.Packaging/src/PACKAGE.md b/src/libraries/System.IO.Packaging/src/PACKAGE.md index f3cbe0ec77412..8ada821aaf440 100644 --- a/src/libraries/System.IO.Packaging/src/PACKAGE.md +++ b/src/libraries/System.IO.Packaging/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.IO.Pipelines/src/PACKAGE.md b/src/libraries/System.IO.Pipelines/src/PACKAGE.md index 07b76a5a6e0bb..97b03f5e636c6 100644 --- a/src/libraries/System.IO.Pipelines/src/PACKAGE.md +++ b/src/libraries/System.IO.Pipelines/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Memory.Data/src/PACKAGE.md b/src/libraries/System.Memory.Data/src/PACKAGE.md index a41bbe80d1089..9c4f30806907e 100644 --- a/src/libraries/System.Memory.Data/src/PACKAGE.md +++ b/src/libraries/System.Memory.Data/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Numerics.Tensors/src/PACKAGE.md b/src/libraries/System.Numerics.Tensors/src/PACKAGE.md index 3959650cfacd5..22d1b422ffccf 100644 --- a/src/libraries/System.Numerics.Tensors/src/PACKAGE.md +++ b/src/libraries/System.Numerics.Tensors/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Reflection.Context/src/PACKAGE.md b/src/libraries/System.Reflection.Context/src/PACKAGE.md index 6b3ea0dccc6e9..74ea38d8033bc 100644 --- a/src/libraries/System.Reflection.Context/src/PACKAGE.md +++ b/src/libraries/System.Reflection.Context/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Resources.Extensions/src/PACKAGE.md b/src/libraries/System.Resources.Extensions/src/PACKAGE.md index bc740503b6c4f..714d6c3fa8d4b 100644 --- a/src/libraries/System.Resources.Extensions/src/PACKAGE.md +++ b/src/libraries/System.Resources.Extensions/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Runtime.Serialization.Schema/src/PACKAGE.md b/src/libraries/System.Runtime.Serialization.Schema/src/PACKAGE.md index 32703b7a9171e..cbc39f05fa946 100644 --- a/src/libraries/System.Runtime.Serialization.Schema/src/PACKAGE.md +++ b/src/libraries/System.Runtime.Serialization.Schema/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Security.Cryptography.Cose/src/PACKAGE.md b/src/libraries/System.Security.Cryptography.Cose/src/PACKAGE.md index c07b43e1d8978..f84f8af4d2107 100644 --- a/src/libraries/System.Security.Cryptography.Cose/src/PACKAGE.md +++ b/src/libraries/System.Security.Cryptography.Cose/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Security.Cryptography.Pkcs/src/PACKAGE.md b/src/libraries/System.Security.Cryptography.Pkcs/src/PACKAGE.md index c6b169ef2a5f9..77e903580c678 100644 --- a/src/libraries/System.Security.Cryptography.Pkcs/src/PACKAGE.md +++ b/src/libraries/System.Security.Cryptography.Pkcs/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md b/src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md index 3540bcfc25384..09e7633669016 100644 --- a/src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md +++ b/src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Security.Cryptography.Xml/src/PACKAGE.md b/src/libraries/System.Security.Cryptography.Xml/src/PACKAGE.md index 66dd9122df501..9822f0f06533a 100644 --- a/src/libraries/System.Security.Cryptography.Xml/src/PACKAGE.md +++ b/src/libraries/System.Security.Cryptography.Xml/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Security.Permissions/src/PACKAGE.md b/src/libraries/System.Security.Permissions/src/PACKAGE.md index 42702c77c66c4..ff4038b86dec7 100644 --- a/src/libraries/System.Security.Permissions/src/PACKAGE.md +++ b/src/libraries/System.Security.Permissions/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md b/src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md index 1fc03ca6f9007..5d99b5df6e942 100644 --- a/src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md +++ b/src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Text.Encodings.Web/src/PACKAGE.md b/src/libraries/System.Text.Encodings.Web/src/PACKAGE.md index b052cd5f92a26..2c1dbff0851d5 100644 --- a/src/libraries/System.Text.Encodings.Web/src/PACKAGE.md +++ b/src/libraries/System.Text.Encodings.Web/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Threading.AccessControl/src/PACKAGE.md b/src/libraries/System.Threading.AccessControl/src/PACKAGE.md index ac3658ca62f32..eae4bdfe0f4ca 100644 --- a/src/libraries/System.Threading.AccessControl/src/PACKAGE.md +++ b/src/libraries/System.Threading.AccessControl/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Threading.RateLimiting/src/PACKAGE.md b/src/libraries/System.Threading.RateLimiting/src/PACKAGE.md index 72a0f2a9bc8d9..c1078de92361b 100644 --- a/src/libraries/System.Threading.RateLimiting/src/PACKAGE.md +++ b/src/libraries/System.Threading.RateLimiting/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Threading.Tasks.Dataflow/src/PACKAGE.md b/src/libraries/System.Threading.Tasks.Dataflow/src/PACKAGE.md index d435316b7785b..c321c68a29816 100644 --- a/src/libraries/System.Threading.Tasks.Dataflow/src/PACKAGE.md +++ b/src/libraries/System.Threading.Tasks.Dataflow/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation diff --git a/src/libraries/System.Windows.Extensions/src/PACKAGE.md b/src/libraries/System.Windows.Extensions/src/PACKAGE.md index 90d18f7b5643e..912da7dffa9a6 100644 --- a/src/libraries/System.Windows.Extensions/src/PACKAGE.md +++ b/src/libraries/System.Windows.Extensions/src/PACKAGE.md @@ -26,7 +26,7 @@ The main types provided by this library are: * `` * `` -## Addtional Documentation +## Additional Documentation From 3b1d2dc37bc4413091c933959c032b360d6c0ebb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= Date: Wed, 18 Oct 2023 00:34:17 +0200 Subject: [PATCH 08/23] Provide Microsoft.Extentions.FileProviders.Abstractions package readme (#93489) * Provide FileProviders.Abstractions package readme * Improve how to use section --- .../src/PACKAGE.md | 27 ++++++++++++------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/PACKAGE.md index efb7ca7c9133c..bbb9b68a06e4a 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/PACKAGE.md @@ -2,43 +2,50 @@ - +Serves as the foundation for creating file providers in .NET, offering core abstractions to develop custom file providers capable of fetching files from various sources. ## Key Features -* -* -* +* Core abstractions for creating and managing file providers. +* Flexibility to develop custom file providers for fetching files from distinct sources. ## How to Use +This package is typically used with an implementation of the file provider abstractions, such as `Microsoft.Extensions.FileProviders.Composite` or `Microsoft.Extensions.FileProviders.Physical`. + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `Microsoft.Extensions.FileProviders.IFileProvider` +* `Microsoft.Extensions.FileProviders.IDirectoryContents` +* `Microsoft.Extensions.FileProviders.IFileInfo` +* `Microsoft.Extensions.FileProviders.NullFileProvider` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/aspnet/core/fundamentals/file-providers) +* [Detect changes with change tokens](https://learn.microsoft.com/aspnet/core/fundamentals/change-tokens) +* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.fileproviders) ## Related Packages +* File provider for physical files: [Microsoft.Extensions.FileProviders.Physical](https://www.nuget.org/packages/Microsoft.Extensions.FileProviders.Physical/) +* File provider for files in embedded resources: [Microsoft.Extensions.FileProviders.Embedded](https://www.nuget.org/packages/Microsoft.Extensions.FileProviders.Embedded/) +* Composite file and directory providers: [Microsoft.Extensions.FileProviders.Composite](https://www.nuget.org/packages/Microsoft.Extensions.FileProviders.Composite/) + ## Feedback & Contributing -Microsoft.Extensions.FileProviders.Abstractions is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +Microsoft.Extensions.FileProviders.Abstractions is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). From 9d0b2061256a7bff7b90734c25c65137706ec1d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= Date: Wed, 18 Oct 2023 00:34:36 +0200 Subject: [PATCH 09/23] Provide Microsoft.Extentions.FileProviders.Physical package readme (#93485) * Provide FileProviders.Physical package readme * Remove whitespace --- .../src/PACKAGE.md | 44 +++++++++++++++---- 1 file changed, 35 insertions(+), 9 deletions(-) diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PACKAGE.md index bf3378a56e63d..6ffcd73312020 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PACKAGE.md @@ -2,43 +2,69 @@ +Provides an implementation of a physical file provider, facilitating file access and monitoring on the disk. The primary type, [`PhysicalFileProvider`](https://learn.microsoft.com/dotnet/api/microsoft.extensions.fileproviders.physicalfileprovider), enables the lookup of files on disk and can watch for changes either via `FileSystemWatcher` or polling mechanisms. ## Key Features -* -* -* +* Easy access and monitoring of files on the disk. +* Ability to watch for file changes either by using `FileSystemWatcher` or through polling. ## How to Use +This library can be used to look up files on disk and monitor file changes effectively. +Below is an example of how to use the `PhysicalFileProvider` to access files on disk and monitor changes: + +```c# +using Microsoft.Extensions.FileProviders; +using Microsoft.Extensions.FileProviders.Physical; + +using var provider = new PhysicalFileProvider(AppContext.BaseDirectory); + +Environment.SetEnvironmentVariable("DOTNET_USE_POLLING_FILE_WATCHER", "1"); + +var contents = provider.GetDirectoryContents(string.Empty); +foreach (PhysicalFileInfo fileInfo in contents) +{ + Console.WriteLine(fileInfo.PhysicalPath); +} + +var changeToken = provider.Watch("*.txt"); +changeToken.RegisterChangeCallback(_ => Console.WriteLine("Text file changed"), null); + +Console.ReadLine(); +``` + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `Microsoft.Extensions.FileProviders.PhysicalFileProvider` +* `Microsoft.Extensions.FileProviders.PhysicalDirectoryInfo` +* `Microsoft.Extensions.FileProviders.PhysicalFileInfo` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/aspnet/core/fundamentals/file-providers#physical-file-provider) +* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.fileproviders.physical) ## Related Packages +* Abstractions of files and directories: [Microsoft.Extensions.FileProviders.Abstractions](https://www.nuget.org/packages/Microsoft.Extensions.FileProviders.Abstractions/) +* File system globbing to find files matching a specified pattern: [Microsoft.Extensions.FileSystemGlobbing](https://www.nuget.org/packages/Microsoft.Extensions.FileSystemGlobbing/) + ## Feedback & Contributing -Microsoft.Extensions.FileProviders.Physical is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +Microsoft.Extensions.FileProviders.Physical is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). From fc488029eeeab8117dcb5a33fe60c3f00c3daaa1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= Date: Wed, 18 Oct 2023 01:45:52 +0200 Subject: [PATCH 10/23] Provide DirectoryServices.Protocols package readme (#93518) --- .../src/PACKAGE.md | 43 +++++++++++++++---- 1 file changed, 34 insertions(+), 9 deletions(-) diff --git a/src/libraries/System.DirectoryServices.Protocols/src/PACKAGE.md b/src/libraries/System.DirectoryServices.Protocols/src/PACKAGE.md index 61bbd897786b2..2938eee70fa8b 100644 --- a/src/libraries/System.DirectoryServices.Protocols/src/PACKAGE.md +++ b/src/libraries/System.DirectoryServices.Protocols/src/PACKAGE.md @@ -2,43 +2,68 @@ +System.DirectoryServices.Protocols provides a managed implementation of Lightweight Directory Access Protocol (LDAP) version 3 and Directory Services Markup Language (DSML) version 2.0 (V2) standards. +It primarily uses the `LdapConnection` type for interacting with LDAP servers, using system native libraries to establish TCP/IP or UDP LDAP connections. +Supports both Windows and Unix, but certain features, such as setting client or server certificate options, are not available on Unix. ## Key Features -* -* -* +* Managed implementation of LDAP v3 and DSML V2 standards. ## How to Use +Using the `LdapConnection` type, you can establish connections to LDAP servers and issue requests. + +Here is a simple example: + +```csharp +using System.DirectoryServices.Protocols; + +// Create a new LdapConnection instance using the server URL. +using (LdapConnection connection = new LdapConnection("ldap.example.com")) { + + // Some credentials + connection.Credential = new NetworkCredential(dn, password); + + // Connect to the server + connection.Bind(); + + // Perform LDAP operations +} +``` + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `System.DirectoryServices.Protocols.LdapConnection` +* `System.DirectoryServices.Protocols.DirectoryAttribute` +* `System.DirectoryServices.Protocols.DirectoryOperation` +* `System.DirectoryServices.Protocols.DirectoryRequest` +* `System.DirectoryServices.Protocols.DirectoryResponse` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [API documentation](https://learn.microsoft.com/dotnet/api/system.directoryservices.protocols) +* [Active Directory Domain Services](https://learn.microsoft.com/windows/win32/ad/active-directory-domain-services) ## Related Packages +* [System.DirectoryServices](https://www.nuget.org/packages/System.DirectoryServices/) + ## Feedback & Contributing -System.DirectoryServices.Protocols is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +System.DirectoryServices.Protocols is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). From 2610c534625ab78c271add500473e6cec03e0074 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= Date: Wed, 18 Oct 2023 08:14:30 +0200 Subject: [PATCH 11/23] Provide System.IO.Hashing package readme (#93567) --- .../System.IO.Hashing/src/PACKAGE.md | 65 ++++++++++++++++--- 1 file changed, 56 insertions(+), 9 deletions(-) diff --git a/src/libraries/System.IO.Hashing/src/PACKAGE.md b/src/libraries/System.IO.Hashing/src/PACKAGE.md index 5bb2b57175907..64fa5ff754845 100644 --- a/src/libraries/System.IO.Hashing/src/PACKAGE.md +++ b/src/libraries/System.IO.Hashing/src/PACKAGE.md @@ -2,43 +2,90 @@ +System.IO.Hashing offers a variety of hash code algorithms. +Hash code algorithms are pivotal for generating unique values for objects based on their content, facilitating object comparisons, and detecting content alterations. +The namespace encompasses algorithms like CRC-32, CRC-64, xxHash3, xxHash32, xxHash64, and xxHash128, all engineered for swift and efficient hash code generation, with xxHash being an "Extremely fast hash algorithm". + +**Warning**: The hash functions provided by System.IO.Hashing are not suitable for security purposes such as handling passwords or verifying untrusted content. +For such security-critical applications, consider using cryptographic hash functions provided by the [System.Security.Cryptography](https://learn.microsoft.com/en-us/dotnet/api/system.security.cryptography) namespace. ## Key Features -* -* -* +* Variety of hash code algorithms including CRC-32, CRC-64, xxHash3, xxHash32, xxHash64, and xxHash128. +* Implementations of CRC-32 and CRC-64 algorithms, as used in IEEE 802.3, and described in ECMA-182, Annex B respectively. +* Implementations of XxHash32 for generating 32-bit hashes, XxHash3 and XxHash64 for generating 64-bit hashes, and xxHash128 for generating 128-bit hashes. ## How to Use +Creating hash codes is straightforward. +Call the `Hash` method with the content to be hashed. + +Here is a practical example: + +```csharp +using System; +using System.IO.Hashing; + +byte[] data = new byte[] { 1, 2, 3, 4 }; + +byte[] crc32Value = Crc32.Hash(data); +Console.WriteLine($"CRC-32 Hash: {BitConverter.ToString(crc32Value)}"); +// CRC-32 Hash: CD-FB-3C-B6 + +byte[] crc64Value = Crc64.Hash(data); +Console.WriteLine($"CRC-64 Hash: {BitConverter.ToString(crc64Value)}"); +// CRC-64 Hash: 58-8D-5A-D4-2A-70-1D-B2 + +byte[] xxHash3Value = XxHash3.Hash(data); +Console.WriteLine($"XxHash3 Hash: {BitConverter.ToString(xxHash3Value)}"); +// XxHash3 Hash: 98-8B-7B-90-33-AC-46-22 + +byte[] xxHash32Value = XxHash32.Hash(data); +Console.WriteLine($"XxHash32 Hash: {BitConverter.ToString(xxHash32Value)}"); +// XxHash32 Hash: FE-96-D1-9C + +byte[] xxHash64Value = XxHash64.Hash(data); +Console.WriteLine($"XxHash64 Hash: {BitConverter.ToString(xxHash64Value)}"); +// XxHash64 Hash: 54-26-20-E3-A2-A9-2E-D1 + +byte[] xxHash128Value = XxHash128.Hash(data); +Console.WriteLine($"XxHash128 Hash: {BitConverter.ToString(xxHash128Value)}"); +// XxHash128 Hash: 49-A0-48-99-59-7A-35-67-53-76-53-A0-D9-95-5B-86 +``` + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `System.IO.Hashing.Crc32` +* `System.IO.Hashing.Crc64` +* `System.IO.Hashing.XxHash3` +* `System.IO.Hashing.XxHash32` +* `System.IO.Hashing.XxHash64` +* `System.IO.Hashing.XxHash128` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [API documentation](https://learn.microsoft.com/dotnet/api/system.io.hashing) +* [xxHash - Extremely fast hash algorithm](https://github.com/Cyan4973/xxHash/blob/release/doc/xxhash_spec.md) ## Related Packages +Cryptographic services, including secure encryption and decryption of data: [System.Security.Cryptography](https://learn.microsoft.com/dotnet/api/system.security.cryptography) + ## Feedback & Contributing -System.IO.Hashing is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +System.IO.Hashing is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). From fc02f61386980a20e874ddc4d4c48fade49652d6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= Date: Wed, 18 Oct 2023 22:05:14 +0200 Subject: [PATCH 12/23] Provide Microsoft.Extensions.Options.DataAnnotations package readme (#93657) --- .../src/PACKAGE.md | 49 +++++++++++++++---- 1 file changed, 40 insertions(+), 9 deletions(-) diff --git a/src/libraries/Microsoft.Extensions.Options.DataAnnotations/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Options.DataAnnotations/src/PACKAGE.md index 3bf3280ad4cf1..368518bbedb31 100644 --- a/src/libraries/Microsoft.Extensions.Options.DataAnnotations/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.Options.DataAnnotations/src/PACKAGE.md @@ -2,43 +2,74 @@ +Microsoft.Extensions.Options.DataAnnotations is a library that adds extra validation functionality to configuration options using data annotations. +It allows to apply validation rules to configuration classes to ensure they are correctly configured before the application starts running. + +This way, misconfiguration issues are catched early during the application startup rather than facing them later in production. ## Key Features -* -* -* +* Enables validation of configuration options using data annotations. +* Early detection of misconfiguration issues during application startup. ## How to Use +While configuring services, chain the `ValidateDataAnnotations()` and `ValidateOnStart()` methods to the `AddOptions` method for your configuration class. + +Here is a simple example demonstrating how to validate options on application startup: + +```csharp +services + .AddOptions() + .ValidateDataAnnotations() + .ValidateOnStart(); +``` + +In the configuration class, use data annotations to specify the validation rules. + +For instance, in the following `MyOptions` class, the `Name` property is marked as required: + +```csharp +using System.ComponentModel.DataAnnotations; + +public class MyOptions +{ + [Required(AllowEmptyStrings = false)] + public string Name { get; set; } +} +``` + +With this setup, an error indicating that the `Name` field is required will be thrown upon startup if it hasn't been configured. + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `Microsoft.Extensions.Options.DataAnnotationsValidateOptions` +* `Microsoft.Extensions.DependencyInjection.OptionsBuilderDataAnnotationsExtensions` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/core/extensions/options) +* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.options.dataannotationvalidateoptions-1) ## Related Packages +Core options: [Microsoft.Extensions.Options](https://www.nuget.org/packages/Microsoft.Extensions.Options/) + ## Feedback & Contributing -Microsoft.Extensions.Options.DataAnnotations is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +Microsoft.Extensions.Options.DataAnnotations is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). From 6959db94f1647af44519a9d830de856e7fd8e46b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= Date: Thu, 19 Oct 2023 21:37:30 +0200 Subject: [PATCH 13/23] Provide Microsoft.Extensions.Caching.Abstractions package readme (#93653) * Provide Caching.Abstractions package readme * Process feedback --- .../src/PACKAGE.md | 27 ++++++++++++------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PACKAGE.md index 651e3c04c9840..eb8a9beacbc44 100644 --- a/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.Caching.Abstractions/src/PACKAGE.md @@ -2,43 +2,52 @@ +Provides the abstractions to create and use in-memory and distributed caching in your applications. +This library defines how in-memory and distributed caches should be implemented; it doesn’t contain any cache implementation. +With the abstractions provided in this library, various types of caches can be built and used interchangeably, whether the data is kept in memory, in files, or even across a network. ## Key Features -* -* -* +* Interfaces for building and using in-memory and distributed caches. ## How to Use +This package is typically used with an implementation of the caching abstractions, such as `Microsoft.Extensions.Caching.Memory` or `Microsoft.Extensions.Caching.SqlServer`. + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `Microsoft.Extensions.Caching.Abstractions.ICacheEntry` +* `Microsoft.Extensions.Caching.Abstractions.IMemoryCache` +* `Microsoft.Extensions.Caching.Abstractions.IDistributedCache` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/core/extensions/caching) +* API documentation + * [Microsoft.Extensions.Caching.Memory](https://learn.microsoft.com/dotnet/api/microsoft.extensions.caching.memory) + * [Microsoft.Extensions.Caching.Distributed](https://learn.microsoft.com/dotnet/api/microsoft.extensions.caching.distributed) ## Related Packages +* In-memory caching: [Microsoft.Extensions.Caching.Memory](https://www.nuget.org/packages/Microsoft.Extensions.Caching.Memory/) +* SQL Server caching: [Microsoft.Extensions.Caching.SqlServer](https://www.nuget.org/packages/Microsoft.Extensions.Caching.SqlServer/) +* Redis caching: [Microsoft.Extensions.Caching.StackExchangeRedis](https://www.nuget.org/packages/Microsoft.Extensions.Caching.StackExchangeRedis/) + ## Feedback & Contributing -Microsoft.Extensions.Caching.Abstractions is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +Microsoft.Extensions.Caching.Abstractions is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). From 298770700c0378eecb14cfaab7644968190d76c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= Date: Thu, 19 Oct 2023 21:42:26 +0200 Subject: [PATCH 14/23] Provide System.Memory.Data package readme (#93516) * Provide System.Memory.Data package readme * Update src/libraries/System.Memory.Data/src/PACKAGE.md --------- Co-authored-by: Viktor Hofer --- .../System.Memory.Data/src/PACKAGE.md | 84 ++++++++++++++++--- 1 file changed, 71 insertions(+), 13 deletions(-) diff --git a/src/libraries/System.Memory.Data/src/PACKAGE.md b/src/libraries/System.Memory.Data/src/PACKAGE.md index 9c4f30806907e..33996a16b0825 100644 --- a/src/libraries/System.Memory.Data/src/PACKAGE.md +++ b/src/libraries/System.Memory.Data/src/PACKAGE.md @@ -2,43 +2,101 @@ +System.Memory.Data introduces the `BinaryData` type, a lightweight abstraction for a byte payload. +It makes it easy to convert between string, bytes, and stream. + +This abstraction can simplify the API surface by exposing a single type instead of numerous overloads or properties. +The `BinaryData` type handles data ownership efficiently, wrapping passed-in bytes when using `byte[]` or `ReadOnlyMemory` constructors or methods, and managing data as bytes when dealing with streams, strings, or rich model types serialized as JSON. ## Key Features -* -* -* +* Lightweight abstraction for byte payload via `BinaryData` type. +* Convenient helper methods for common conversions among string, bytes, and stream. +* Efficient data ownership handling. ## How to Use +To/From String: + +```csharp +var data = new BinaryData("some data"); + +// ToString will decode the bytes using UTF-8 +Console.WriteLine(data.ToString()); // prints "some data" +``` + +To/From Bytes: + +```csharp +byte[] bytes = Encoding.UTF8.GetBytes("some data"); + +// Create BinaryData using a constructor ... +BinaryData data = new BinaryData(bytes); + +// Or using a static factory method. +data = BinaryData.FromBytes(bytes); + +// There is an implicit cast defined for ReadOnlyMemory +ReadOnlyMemory rom = data; + +// There is also an implicit cast defined for ReadOnlySpan +ReadOnlySpan ros = data; + +// there is also a ToMemory method that gives access to the ReadOnlyMemory. +rom = data.ToMemory(); + +// and a ToArray method that converts into a byte array. +byte[] array = data.ToArray(); +``` + +To/From stream: + +```csharp +var bytes = Encoding.UTF8.GetBytes("some data"); +Stream stream = new MemoryStream(bytes); +var data = BinaryData.FromStream(stream); + +// Calling ToStream will give back a stream that is backed by ReadOnlyMemory, so it is not writable. +stream = data.ToStream(); +Console.WriteLine(stream.CanWrite); // prints false +``` + +`BinaryData` also can be used to integrate with `ObjectSerializer`. +By default, the `JsonObjectSerializer` will be used, but any serializer deriving from `ObjectSerializer` can be used. + +```csharp +var model = new CustomModel +{ + A = "some text", + B = 5, + C = true +}; + +var data = BinaryData.FromObjectAsJson(model); +model = data.ToObjectFromJson(); +``` + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `System.BinaryData` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) - -## Related Packages - - +* [API documentation](https://learn.microsoft.com/dotnet/api/system.binarydata) ## Feedback & Contributing -System.Memory.Data is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +System.Memory.Data is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). From 3f41ed384c5ab1fa478bf5d7f1667c28e106c2ab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= Date: Fri, 20 Oct 2023 00:05:04 +0200 Subject: [PATCH 15/23] Provide System.Security.Cryptography.ProtectedData package readme (#93660) * Provide Cryptography.ProtectedData package readme * Processing review comments * Remove paragraph and improve sentence * Improve code sample --- .../src/PACKAGE.md | 48 +++++++++++++++---- 1 file changed, 38 insertions(+), 10 deletions(-) diff --git a/src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md b/src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md index 09e7633669016..7a0f751326f55 100644 --- a/src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md +++ b/src/libraries/System.Security.Cryptography.ProtectedData/src/PACKAGE.md @@ -2,43 +2,71 @@ +System.Security.Cryptography.ProtectedData offers a simplified interface for utilizing Microsoft Windows DPAPI's [CryptProtectData](https://learn.microsoft.com/windows/win32/api/dpapi/nf-dpapi-cryptprotectdata) and [CryptUnprotectData](https://learn.microsoft.com/windows/win32/api/dpapi/nf-dpapi-cryptunprotectdata) functions. +**Note**: Since it relies on Windows DPAPI, this package is only supported on Windows platforms. +For more complex cryptographic operations or cross-platform support, consider the [System.Security.Cryptography](https://learn.microsoft.com/dotnet/api/system.security.cryptography) namespace. ## Key Features -* -* -* +* Built upon the robust and secure Windows Data Protection API (DPAPI). +* Data can be protected either for current process or for any process on the machine. +* Scope of protection can be defined either to the current user or the local machine. ## How to Use +Utilizing this package is quite simple, and it mainly revolves around two methods: `Protect` and `Unprotect`. + +Here, `originalData` is the data you want to protect, `optionalEntropy` is an additional byte array used to increase encryption complexity, and `DataProtectionScope` specifies whether the data protection should apply to the current user or the machine. + +```csharp +using System.Security.Cryptography; +using System.Text; + +byte[] originalData = Encoding.UTF8.GetBytes("This is a secret"); +byte[] optionalEntropy = new byte[64]; +Random.Shared.NextBytes(optionalEntropy); + +// To protect: +byte[] encryptedData = ProtectedData.Protect( + originalData, + optionalEntropy, + DataProtectionScope.CurrentUser); + +// To unprotect: +byte[] decryptedData = ProtectedData.Unprotect( + encryptedData, + optionalEntropy, + DataProtectionScope.CurrentUser); +``` + ## Main Types -The main types provided by this library are: +The main type provided by this library is: -* `` -* `` -* `` +* `System.Security.Cryptography.ProtectedData` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/security/how-to-use-data-protection) +* [API documentation](https://learn.microsoft.com/dotnet/api/system.security.cryptography.protecteddata) ## Related Packages +* PKCS and CMS algorithms: [System.Security.Cryptography.Pkcs](https://www.nuget.org/packages/System.Security.Cryptography.Pkcs/) + ## Feedback & Contributing -System.Security.Cryptography.ProtectedData is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +System.Security.Cryptography.ProtectedData is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). From a1caacf2941012d1fdd28d986a417815874281e3 Mon Sep 17 00:00:00 2001 From: Viktor Hofer Date: Fri, 20 Oct 2023 10:13:07 +0200 Subject: [PATCH 16/23] Remove en-us culture code from URIs --- src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md | 2 +- .../src/PACKAGE.md | 4 ++-- .../src/PACKAGE.md | 4 ++-- .../Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md | 2 +- .../Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md | 4 ++-- .../Microsoft.Extensions.Logging.Configuration/src/PACKAGE.md | 4 ++-- .../Microsoft.Extensions.Logging.EventSource/src/PACKAGE.md | 4 ++-- .../Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md | 2 +- .../Microsoft.NET.WebAssembly.Threading/src/PACKAGE.md | 4 ++-- .../Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md | 4 ++-- src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md | 4 ++-- .../Microsoft.XmlSerializer.Generator/src/PACKAGE.md | 4 ++-- src/libraries/System.CodeDom/src/PACKAGE.md | 4 ++-- .../src/PACKAGE.md | 4 ++-- .../System.ComponentModel.Composition/src/PACKAGE.md | 4 ++-- .../System.Composition.AttributedModel/src/PACKAGE.md | 4 ++-- src/libraries/System.Composition.Convention/src/PACKAGE.md | 4 ++-- src/libraries/System.Composition.Hosting/src/PACKAGE.md | 4 ++-- src/libraries/System.Composition.Runtime/src/PACKAGE.md | 4 ++-- src/libraries/System.Composition.TypedParts/src/PACKAGE.md | 4 ++-- src/libraries/System.Composition/src/PACKAGE.md | 4 ++-- .../System.Diagnostics.DiagnosticSource/src/PACKAGE.md | 4 ++-- src/libraries/System.Formats.Cbor/src/PACKAGE.md | 2 +- src/libraries/System.IO.Hashing/src/PACKAGE.md | 2 +- src/libraries/System.IO.Packaging/src/PACKAGE.md | 4 ++-- src/libraries/System.IO.Pipelines/src/PACKAGE.md | 4 ++-- src/libraries/System.Numerics.Tensors/src/PACKAGE.md | 4 ++-- src/libraries/System.Reflection.Context/src/PACKAGE.md | 4 ++-- src/libraries/System.Resources.Extensions/src/PACKAGE.md | 4 ++-- .../System.Runtime.Serialization.Schema/src/PACKAGE.md | 4 ++-- .../System.Security.Cryptography.Cose/src/PACKAGE.md | 4 ++-- .../System.Security.Cryptography.Pkcs/src/PACKAGE.md | 4 ++-- src/libraries/System.Security.Cryptography.Xml/src/PACKAGE.md | 4 ++-- src/libraries/System.Security.Permissions/src/PACKAGE.md | 4 ++-- src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md | 4 ++-- src/libraries/System.Text.Encodings.Web/src/PACKAGE.md | 4 ++-- src/libraries/System.Threading.AccessControl/src/PACKAGE.md | 4 ++-- src/libraries/System.Threading.RateLimiting/src/PACKAGE.md | 4 ++-- src/libraries/System.Threading.Tasks.Dataflow/src/PACKAGE.md | 4 ++-- src/libraries/System.Windows.Extensions/src/PACKAGE.md | 4 ++-- 40 files changed, 75 insertions(+), 75 deletions(-) diff --git a/src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md b/src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md index 4346252b24386..215d29e162c4b 100644 --- a/src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md +++ b/src/libraries/Microsoft.Bcl.Cryptography/src/PACKAGE.md @@ -32,7 +32,7 @@ The main types provided by this library are: ## Additional Documentation -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/System.Security.Cryptography) +* [API documentation](https://learn.microsoft.com/dotnet/api/System.Security.Cryptography) ## Feedback & Contributing diff --git a/src/libraries/Microsoft.Extensions.DependencyInjection.Specification.Tests/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.DependencyInjection.Specification.Tests/src/PACKAGE.md index 79b5aea01302e..0f8ded5894e88 100644 --- a/src/libraries/Microsoft.Extensions.DependencyInjection.Specification.Tests/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.DependencyInjection.Specification.Tests/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/PACKAGE.md index 122fbecfa2ba9..eb20a0af87eba 100644 --- a/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.FileProviders.Composite/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md index 433fa943e1172..25bd9129c3968 100644 --- a/src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md @@ -42,7 +42,7 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/core/extensions/file-globbing) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/core/extensions/file-globbing) * [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.filesystemglobbing) ## Feedback & Contributing diff --git a/src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md index ffb5501c8568f..84d1bdaf706e0 100644 --- a/src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/Microsoft.Extensions.Logging.Configuration/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Logging.Configuration/src/PACKAGE.md index 7c38fc44d350f..eb3cd431b79fc 100644 --- a/src/libraries/Microsoft.Extensions.Logging.Configuration/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.Logging.Configuration/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/Microsoft.Extensions.Logging.EventSource/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/PACKAGE.md index 8a67a2888f46d..2d071f613b9f2 100644 --- a/src/libraries/Microsoft.Extensions.Logging.EventSource/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.Logging.EventSource/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md index 25abc578ba6d3..a58e190ec552b 100644 --- a/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.Logging.TraceSource/src/PACKAGE.md @@ -58,7 +58,7 @@ The main types provided by this library are: -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.tracesource) +* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.logging.tracesource) ## Related Packages diff --git a/src/libraries/Microsoft.NET.WebAssembly.Threading/src/PACKAGE.md b/src/libraries/Microsoft.NET.WebAssembly.Threading/src/PACKAGE.md index 009758b7e5f78..dc32241e2f569 100644 --- a/src/libraries/Microsoft.NET.WebAssembly.Threading/src/PACKAGE.md +++ b/src/libraries/Microsoft.NET.WebAssembly.Threading/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md b/src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md index f74e2de2b1ea3..4e35cf443fad5 100644 --- a/src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md +++ b/src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md b/src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md index 4d4256fedf744..868a31065bcc0 100644 --- a/src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md +++ b/src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/Microsoft.XmlSerializer.Generator/src/PACKAGE.md b/src/libraries/Microsoft.XmlSerializer.Generator/src/PACKAGE.md index b83986018d2e7..fa88d0dd906bb 100644 --- a/src/libraries/Microsoft.XmlSerializer.Generator/src/PACKAGE.md +++ b/src/libraries/Microsoft.XmlSerializer.Generator/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.CodeDom/src/PACKAGE.md b/src/libraries/System.CodeDom/src/PACKAGE.md index 259e0feb50cec..cb86c12634572 100644 --- a/src/libraries/System.CodeDom/src/PACKAGE.md +++ b/src/libraries/System.CodeDom/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.ComponentModel.Composition.Registration/src/PACKAGE.md b/src/libraries/System.ComponentModel.Composition.Registration/src/PACKAGE.md index 2fa0eb6196f3c..e78dbe81a5177 100644 --- a/src/libraries/System.ComponentModel.Composition.Registration/src/PACKAGE.md +++ b/src/libraries/System.ComponentModel.Composition.Registration/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.ComponentModel.Composition/src/PACKAGE.md b/src/libraries/System.ComponentModel.Composition/src/PACKAGE.md index 0096b2acdca3f..348d4638c5d81 100644 --- a/src/libraries/System.ComponentModel.Composition/src/PACKAGE.md +++ b/src/libraries/System.ComponentModel.Composition/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Composition.AttributedModel/src/PACKAGE.md b/src/libraries/System.Composition.AttributedModel/src/PACKAGE.md index 1f533435c4b86..50bae9a7bde0e 100644 --- a/src/libraries/System.Composition.AttributedModel/src/PACKAGE.md +++ b/src/libraries/System.Composition.AttributedModel/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Composition.Convention/src/PACKAGE.md b/src/libraries/System.Composition.Convention/src/PACKAGE.md index 8cad9d889483b..2d833849f8366 100644 --- a/src/libraries/System.Composition.Convention/src/PACKAGE.md +++ b/src/libraries/System.Composition.Convention/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Composition.Hosting/src/PACKAGE.md b/src/libraries/System.Composition.Hosting/src/PACKAGE.md index be4b5f096e0e0..cfe68edeb2bd6 100644 --- a/src/libraries/System.Composition.Hosting/src/PACKAGE.md +++ b/src/libraries/System.Composition.Hosting/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Composition.Runtime/src/PACKAGE.md b/src/libraries/System.Composition.Runtime/src/PACKAGE.md index 3e30bc15c6832..56964aa6f972e 100644 --- a/src/libraries/System.Composition.Runtime/src/PACKAGE.md +++ b/src/libraries/System.Composition.Runtime/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Composition.TypedParts/src/PACKAGE.md b/src/libraries/System.Composition.TypedParts/src/PACKAGE.md index cf5a4d1cb02ed..4fae4f802fe6e 100644 --- a/src/libraries/System.Composition.TypedParts/src/PACKAGE.md +++ b/src/libraries/System.Composition.TypedParts/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Composition/src/PACKAGE.md b/src/libraries/System.Composition/src/PACKAGE.md index 33a8905040b5f..d53901f84e77d 100644 --- a/src/libraries/System.Composition/src/PACKAGE.md +++ b/src/libraries/System.Composition/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Diagnostics.DiagnosticSource/src/PACKAGE.md b/src/libraries/System.Diagnostics.DiagnosticSource/src/PACKAGE.md index 69b5def89a51c..064ad33b5dd6d 100644 --- a/src/libraries/System.Diagnostics.DiagnosticSource/src/PACKAGE.md +++ b/src/libraries/System.Diagnostics.DiagnosticSource/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Formats.Cbor/src/PACKAGE.md b/src/libraries/System.Formats.Cbor/src/PACKAGE.md index ff26f0debbdc0..b6549d0941e8c 100644 --- a/src/libraries/System.Formats.Cbor/src/PACKAGE.md +++ b/src/libraries/System.Formats.Cbor/src/PACKAGE.md @@ -86,7 +86,7 @@ The main types provided by this library are: -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/system.formats.cbor) +* [API documentation](https://learn.microsoft.com/dotnet/api/system.formats.cbor) ## Feedback & Contributing diff --git a/src/libraries/System.IO.Hashing/src/PACKAGE.md b/src/libraries/System.IO.Hashing/src/PACKAGE.md index 64fa5ff754845..41b90205eac84 100644 --- a/src/libraries/System.IO.Hashing/src/PACKAGE.md +++ b/src/libraries/System.IO.Hashing/src/PACKAGE.md @@ -8,7 +8,7 @@ Hash code algorithms are pivotal for generating unique values for objects based The namespace encompasses algorithms like CRC-32, CRC-64, xxHash3, xxHash32, xxHash64, and xxHash128, all engineered for swift and efficient hash code generation, with xxHash being an "Extremely fast hash algorithm". **Warning**: The hash functions provided by System.IO.Hashing are not suitable for security purposes such as handling passwords or verifying untrusted content. -For such security-critical applications, consider using cryptographic hash functions provided by the [System.Security.Cryptography](https://learn.microsoft.com/en-us/dotnet/api/system.security.cryptography) namespace. +For such security-critical applications, consider using cryptographic hash functions provided by the [System.Security.Cryptography](https://learn.microsoft.com/dotnet/api/system.security.cryptography) namespace. ## Key Features diff --git a/src/libraries/System.IO.Packaging/src/PACKAGE.md b/src/libraries/System.IO.Packaging/src/PACKAGE.md index 8ada821aaf440..cd1d29d8a0e0e 100644 --- a/src/libraries/System.IO.Packaging/src/PACKAGE.md +++ b/src/libraries/System.IO.Packaging/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.IO.Pipelines/src/PACKAGE.md b/src/libraries/System.IO.Pipelines/src/PACKAGE.md index 97b03f5e636c6..2bf8184f1c3b6 100644 --- a/src/libraries/System.IO.Pipelines/src/PACKAGE.md +++ b/src/libraries/System.IO.Pipelines/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Numerics.Tensors/src/PACKAGE.md b/src/libraries/System.Numerics.Tensors/src/PACKAGE.md index 22d1b422ffccf..0e72dd30f59d3 100644 --- a/src/libraries/System.Numerics.Tensors/src/PACKAGE.md +++ b/src/libraries/System.Numerics.Tensors/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Reflection.Context/src/PACKAGE.md b/src/libraries/System.Reflection.Context/src/PACKAGE.md index 74ea38d8033bc..c70706d4e8771 100644 --- a/src/libraries/System.Reflection.Context/src/PACKAGE.md +++ b/src/libraries/System.Reflection.Context/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Resources.Extensions/src/PACKAGE.md b/src/libraries/System.Resources.Extensions/src/PACKAGE.md index 714d6c3fa8d4b..63fabb28dc092 100644 --- a/src/libraries/System.Resources.Extensions/src/PACKAGE.md +++ b/src/libraries/System.Resources.Extensions/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Runtime.Serialization.Schema/src/PACKAGE.md b/src/libraries/System.Runtime.Serialization.Schema/src/PACKAGE.md index cbc39f05fa946..d0a538498d73c 100644 --- a/src/libraries/System.Runtime.Serialization.Schema/src/PACKAGE.md +++ b/src/libraries/System.Runtime.Serialization.Schema/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Security.Cryptography.Cose/src/PACKAGE.md b/src/libraries/System.Security.Cryptography.Cose/src/PACKAGE.md index f84f8af4d2107..82b8df2029e39 100644 --- a/src/libraries/System.Security.Cryptography.Cose/src/PACKAGE.md +++ b/src/libraries/System.Security.Cryptography.Cose/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Security.Cryptography.Pkcs/src/PACKAGE.md b/src/libraries/System.Security.Cryptography.Pkcs/src/PACKAGE.md index 77e903580c678..4c296584a45bc 100644 --- a/src/libraries/System.Security.Cryptography.Pkcs/src/PACKAGE.md +++ b/src/libraries/System.Security.Cryptography.Pkcs/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Security.Cryptography.Xml/src/PACKAGE.md b/src/libraries/System.Security.Cryptography.Xml/src/PACKAGE.md index 9822f0f06533a..6d69a5ce8bc5c 100644 --- a/src/libraries/System.Security.Cryptography.Xml/src/PACKAGE.md +++ b/src/libraries/System.Security.Cryptography.Xml/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Security.Permissions/src/PACKAGE.md b/src/libraries/System.Security.Permissions/src/PACKAGE.md index ff4038b86dec7..3a1d7d40d7873 100644 --- a/src/libraries/System.Security.Permissions/src/PACKAGE.md +++ b/src/libraries/System.Security.Permissions/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md b/src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md index 5d99b5df6e942..81fff57aba651 100644 --- a/src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md +++ b/src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Text.Encodings.Web/src/PACKAGE.md b/src/libraries/System.Text.Encodings.Web/src/PACKAGE.md index 2c1dbff0851d5..acf511b4be5a0 100644 --- a/src/libraries/System.Text.Encodings.Web/src/PACKAGE.md +++ b/src/libraries/System.Text.Encodings.Web/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Threading.AccessControl/src/PACKAGE.md b/src/libraries/System.Threading.AccessControl/src/PACKAGE.md index eae4bdfe0f4ca..fd3a0e78cf295 100644 --- a/src/libraries/System.Threading.AccessControl/src/PACKAGE.md +++ b/src/libraries/System.Threading.AccessControl/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Threading.RateLimiting/src/PACKAGE.md b/src/libraries/System.Threading.RateLimiting/src/PACKAGE.md index c1078de92361b..381d588124a3d 100644 --- a/src/libraries/System.Threading.RateLimiting/src/PACKAGE.md +++ b/src/libraries/System.Threading.RateLimiting/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Threading.Tasks.Dataflow/src/PACKAGE.md b/src/libraries/System.Threading.Tasks.Dataflow/src/PACKAGE.md index c321c68a29816..f15811be3267a 100644 --- a/src/libraries/System.Threading.Tasks.Dataflow/src/PACKAGE.md +++ b/src/libraries/System.Threading.Tasks.Dataflow/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages diff --git a/src/libraries/System.Windows.Extensions/src/PACKAGE.md b/src/libraries/System.Windows.Extensions/src/PACKAGE.md index 912da7dffa9a6..edf526dfe9099 100644 --- a/src/libraries/System.Windows.Extensions/src/PACKAGE.md +++ b/src/libraries/System.Windows.Extensions/src/PACKAGE.md @@ -30,8 +30,8 @@ The main types provided by this library are: -* [Conceptual documentation](https://learn.microsoft.com/en-us/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/en-us/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) +* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) ## Related Packages From bd7cb94a7a3f48c674f706a9e529ac683eee5275 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= Date: Thu, 2 Nov 2023 05:04:57 +0100 Subject: [PATCH 17/23] Provide Extensions.Hosting.Systemd package readme (#94055) --- .../src/PACKAGE.md | 41 +++++++++++++++---- 1 file changed, 32 insertions(+), 9 deletions(-) diff --git a/src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md b/src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md index 84d1bdaf706e0..97a4dd4e2f67f 100644 --- a/src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md +++ b/src/libraries/Microsoft.Extensions.Hosting.Systemd/src/PACKAGE.md @@ -2,43 +2,66 @@ +Provides an implementation for hosting an application as a Linux *systemd* service. +The package ensures proper communication between .NET applications and *systemd*, making it easier to build, deploy, and run applications as Linux services. ## Key Features -* -* -* +* Systemd service integration +* Health check support +* Logging and diagnostics with different log levels +* Notify systemd on application state changes ## How to Use +Wherever you configure your host, add the `UseSystemd` method to the builder chain: + +```csharp +public static IHostBuilder CreateHostBuilder(string[] args) => + Host.CreateDefaultBuilder(args) + .UseSystemd() // Enable running as a Systemd service + .ConfigureServices((hostContext, services) => + { + ... + }); +``` + +The `UseSystemd` method will no-op when not running as a daemon, allowing normal debugging or production use both with and without *systemd*. + +Registering the service requires a special file, called a unit file, to be added to the `/etc/systemd/system` directory. + +For more information on this part, check the [run your app as a Linux service with systemd](https://learn.microsoft.com/dotnet/architecture/grpc-for-wcf-developers/self-hosted#run-your-app-as-a-linux-service-with-systemd) guide. + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `Microsoft.Extensions.Hosting.Systemd.SystemdNotifier` +* `Microsoft.Extensions.Hosting.Systemd.SystemdLifetime` +* `Microsoft.Extensions.Hosting.SystemdHostBuilderExtensions` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/architecture/grpc-for-wcf-developers/self-hosted#run-your-app-as-a-linux-service-with-systemd) +* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.hosting.systemd) ## Related Packages +* [Microsoft.Extensions.Hosting](https://www.nuget.org/packages/Microsoft.Extensions.Hosting) + ## Feedback & Contributing -Microsoft.Extensions.Hosting.Systemd is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +Microsoft.Extensions.Hosting.Systemd is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). From 3c2f2a9a74aad91ed8264c5bc84b6dc25c6bcbad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= Date: Fri, 3 Nov 2023 08:56:19 +0100 Subject: [PATCH 18/23] Provide M.W.Registry.AccessControl package readme (#94321) --- .../src/PACKAGE.md | 56 ++++++++++++++----- 1 file changed, 41 insertions(+), 15 deletions(-) diff --git a/src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md b/src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md index 4e35cf443fad5..8190854cfa830 100644 --- a/src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md +++ b/src/libraries/Microsoft.Win32.Registry.AccessControl/src/PACKAGE.md @@ -2,43 +2,69 @@ - +Provides support for managing access control lists for `Microsoft.Win32.RegistryKey`. ## Key Features -* -* -* +* Get access control lists for a registry key. +* Get a specific sections of an access control list. +* Set the access control list for a registry key. ## How to Use +```csharp +using Microsoft.Win32; +using System.Security.AccessControl; + +// Open a registry key (or create it if it doesn't exist) +using RegistryKey registryKey = Registry.CurrentUser.CreateSubKey("TestKey"); +if (registryKey == null) +{ + Console.WriteLine("Failed to create or open the registry key."); + return; +} + +// Get the current access control list (ACL) for the registry key +RegistrySecurity registrySecurity = registryKey.GetAccessControl(); +Console.WriteLine("Current Access Control List (ACL):"); +Console.WriteLine(registrySecurity.GetSecurityDescriptorSddlForm(AccessControlSections.Access)); + +// Create a new access rule granting full control to the current user +string currentUser = Environment.UserName; +RegistryAccessRule accessRule = new RegistryAccessRule(currentUser, RegistryRights.FullControl, InheritanceFlags.None, PropagationFlags.None, AccessControlType.Allow); + +// Add the new access rule to the ACL +registrySecurity.AddAccessRule(accessRule); + +// Set the updated ACL on the registry key +registryKey.SetAccessControl(registrySecurity); + +// Get and display the updated ACL for the registry key using the second GetAccessControl overload +RegistrySecurity updatedRegistrySecurity = registryKey.GetAccessControl(AccessControlSections.Access); +Console.WriteLine("Updated Access Control List (ACL):"); +Console.WriteLine(updatedRegistrySecurity.GetSecurityDescriptorSddlForm(AccessControlSections.Access)); +``` + ## Main Types -The main types provided by this library are: +The main type provided by this library is: -* `` -* `` -* `` +* `Microsoft.Win32.RegistryAclExtensions` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) - -## Related Packages - - +* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.win32.registryaclextensions) ## Feedback & Contributing -Microsoft.Win32.Registry.AccessControl is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +Microsoft.Win32.Registry.AccessControl is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). From aacb637e6980ae263a6d9251cd947e53564762fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= Date: Mon, 6 Nov 2023 13:00:33 +0100 Subject: [PATCH 19/23] Provide Microsoft.Win32.SystemEvents package readme (#94371) * Provide M.Win32.SystemEvents package readme * Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md * Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md --------- Co-authored-by: Viktor Hofer --- .../src/PACKAGE.md | 63 ++++++++++++++----- 1 file changed, 49 insertions(+), 14 deletions(-) diff --git a/src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md b/src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md index 868a31065bcc0..ca4d0cc02b8a0 100644 --- a/src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md +++ b/src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md @@ -2,43 +2,78 @@ - +Provides support for accessing Windows system event notifications, which can be crucial for applications to respond to changes in the system or user environment​. +Through this assembly, applications can subscribe to a set of global system events provided by the `SystemEvents` class, gaining the ability to react to changes like system power mode alterations, user preference modifications, and session switches, among others. ## Key Features -* -* -* +* Access to a set of global system events +* Notification of changes in user preferences +* Notification of system power mode changes +* Notification of session switches ## How to Use +An example of how to use the `SystemEvents` class to react to system changes: + +```csharp +using Microsoft.Win32; + +// Set the SystemEvents class to receive event notification when a user +// preference changes, the palette changes, or when display settings change. +SystemEvents.UserPreferenceChanging += UserPreferenceChanging; +SystemEvents.PaletteChanged += PaletteChanged; +SystemEvents.DisplaySettingsChanged += DisplaySettingsChanged; + +// For demonstration purposes, this application sits idle waiting for events. +Console.WriteLine("This application is waiting for system events."); +Console.WriteLine("Press to terminate this application."); +Console.ReadLine(); + +// This method is called when a user preference changes. +static void UserPreferenceChanging(object sender, UserPreferenceChangingEventArgs e) +{ + Console.WriteLine($"The user preference is changing. Category={e.Category}"); +} + +// This method is called when the palette changes. +static void PaletteChanged(object sender, EventArgs e) +{ + Console.WriteLine("The palette changed."); +} + +// This method is called when the display settings change. +static void DisplaySettingsChanged(object sender, EventArgs e) +{ + Console.WriteLine("The display settings changed."); +} +``` + +In this example, the methods will be invoked whenever the user modifies one of several system settings. + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `Microsoft.Win32.SystemEvents` +* `Microsoft.Win32.PowerModeChangedEventHandler` +* `Microsoft.Win32.SessionEndedEventHandler` +* `Microsoft.Win32.UserPreferenceChangedEventHandler` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) - -## Related Packages - - +* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.win32.systemevents) ## Feedback & Contributing -Microsoft.Win32.SystemEvents is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +Microsoft.Win32.SystemEvents is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). From d7114001b8f1b04b6620a671620a7f93fbac6556 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= Date: Sat, 11 Nov 2023 21:39:53 +0100 Subject: [PATCH 20/23] Provide System.Text.Encodings.Web package readme (#94637) --- .../System.Text.Encodings.Web/src/PACKAGE.md | 114 ++++++++++++++++-- 1 file changed, 101 insertions(+), 13 deletions(-) diff --git a/src/libraries/System.Text.Encodings.Web/src/PACKAGE.md b/src/libraries/System.Text.Encodings.Web/src/PACKAGE.md index acf511b4be5a0..70885b3aae072 100644 --- a/src/libraries/System.Text.Encodings.Web/src/PACKAGE.md +++ b/src/libraries/System.Text.Encodings.Web/src/PACKAGE.md @@ -2,43 +2,131 @@ +Provides types for encoding and escaping strings for use in JavaScript, HTML, and URLs. +This package is essential for protecting web applications against cross-site scripting (XSS) attacks by safely encoding text, and it offers extensive support for Unicode, allowing fine-grained control over which characters are encoded and which are left unescaped. ## Key Features -* -* -* +* Safe encoders for HTML, JavaScript, and URL strings. +* Extensible to support custom encoding scenarios, including the ability to specify Unicode ranges. +* Helps prevent cross-site scripting (XSS) vulnerabilities. +* Flexible Unicode encoding with support for specifying individual or predefined ranges to cover broader sets of characters, including options to avoid escaping specific language character sets. ## How to Use +### Encoding HTML, JavaScript, and URLs + +```csharp +using System.Text.Encodings.Web; + +string unsafeString = ""; + +// HTML encode the string to safely display it on a web page. +string safeHtml = HtmlEncoder.Default.Encode(unsafeString); +Console.WriteLine(safeHtml); +// <script>alert('XSS Attack!');</script> + +// JavaScript encode the string to safely include it in a JavaScript context. +string safeJavaScript = JavaScriptEncoder.Default.Encode(unsafeString); +Console.WriteLine(safeJavaScript); +// \u003Cscript\u003Ealert(\u0027XSS Attack!\u0027);\u003C/script\u003E + +string urlPart = "user input with spaces and & symbols"; + +// URL encode the string to safely include it in a URL. +string encodedUrlPart = UrlEncoder.Default.Encode(urlPart); +Console.WriteLine(encodedUrlPart); +// user%20input%20with%20spaces%20and%20%26%20symbols +``` + +### Custom Encoding Scenario with Specific Unicode Ranges + +```csharp +using System.Text.Encodings.Web; +using System.Text.Unicode; + +TextEncoderSettings customEncoderSettings = new TextEncoderSettings(); +customEncoderSettings.AllowCharacters('!', '*', '-', '.', '_', '~'); // RFC 3986 unreserved characters +customEncoderSettings.AllowRange(new UnicodeRange('a', 26)); +customEncoderSettings.AllowRange(new UnicodeRange('A', 26)); +customEncoderSettings.AllowRange(new UnicodeRange('0', 10)); + +// Create a URL encoder with the custom settings +UrlEncoder customUrlEncoder = UrlEncoder.Create(customEncoderSettings); + +string customUrlPart = "custom data: (@123!)"; + +// By default, the symbols '(', ')', and '@' are not encoded +string defaultEncoded = UrlEncoder.Default.Encode(customUrlPart); +Console.WriteLine(defaultEncoded); +// custom%20data%3A%20(@123!) + +// Now, the symbols '(', ')', and '@' are also encoded +string customEncoded = customUrlEncoder.Encode(customUrlPart); +Console.WriteLine(customEncoded); +// custom%20data%3A%20%28%40123!%29 +``` + +### Serialization with Specific Unicode Character Sets + +By default Cyrillic characters are encoded as Unicode escape sequences in JSON. + +```json +{ + "Date": "2019-08-01T00:00:00-07:00", + "TemperatureCelsius": 25, + "Summary": "\u0436\u0430\u0440\u043A\u043E" +} +``` + +This can be customized by providing a custom `JavaScriptEncoder` to `JsonSerializerOptions`: + +```csharp +JsonSerializerOptions options = new JsonSerializerOptions +{ + Encoder = JavaScriptEncoder.Create(UnicodeRanges.BasicLatin, UnicodeRanges.Cyrillic), + WriteIndented = true +}; +jsonString = JsonSerializer.Serialize(weatherForecast, options1); +``` + +```json +{ + "Date": "2019-08-01T00:00:00-07:00", + "TemperatureCelsius": 25, + "Summary": "жарко" +} +``` + +More information about this can be found in the [How to customize character encoding with System.Text.Json](https://learn.microsoft.com/dotnet/standard/serialization/system-text-json/character-encoding) article. + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `System.Text.Encodings.Web.HtmlEncoder` +* `System.Text.Encodings.Web.JavaScriptEncoder` +* `System.Text.Encodings.Web.UrlEncoder` +* `System.Text.Encodings.Web.TextEncoder` +* `System.Text.Encodings.Web.TextEncoderSettings` +* `System.Text.Unicode.UnicodeRange` +* `System.Text.Unicode.UnicodeRanges` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) - -## Related Packages - - +* [API documentation](https://learn.microsoft.com/dotnet/api/system.text.encodings.web) ## Feedback & Contributing -System.Text.Encodings.Web is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +System.Text.Encodings.Web is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). From bfa72d38c71293ce8795d6ac428f68945914deac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= Date: Wed, 6 Dec 2023 19:31:56 +0100 Subject: [PATCH 21/23] Provide ServiceModel.Syndication package readme (#94638) --- .../src/PACKAGE.md | 109 +++++++++++++++--- 1 file changed, 95 insertions(+), 14 deletions(-) diff --git a/src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md b/src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md index 81fff57aba651..cde4a0fdb43dc 100644 --- a/src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md +++ b/src/libraries/System.ServiceModel.Syndication/src/PACKAGE.md @@ -2,43 +2,124 @@ - +Provides types for generating and consuming RSS and Atom feeds. +It is used for creating and parsing syndication feeds, making it easier to build and integrate web content syndication. ## Key Features -* -* -* +* Easy generation and parsing of RSS and Atom feeds. +* Customizable for different syndication needs. +* Support for both feed reading and writing. ## How to Use +### Creating a Feed + +```csharp +using System.ServiceModel.Syndication; +using System.Xml; + +// Create a new syndication feed +SyndicationFeed feed = new SyndicationFeed( + "Feed Title", + "Feed Description", + new Uri("http://example.com"), + "FeedID", + DateTime.Now); + +// Add items to the feed +SyndicationItem item1 = new SyndicationItem( + "Title1", + "Content1", + new Uri("http://example.com/item1")); +feed.Items = new List { item1 }; + +// Serialize the feed to RSS format +using (XmlWriter writer = XmlWriter.Create("rss.xml")) +{ + Rss20FeedFormatter rssFormatter = new Rss20FeedFormatter(feed); + rssFormatter.WriteTo(writer); +} +``` + +Resulting RSS feed: + +```xml + + + + Feed Title + http://example.com/ + Feed Description + Sat, 11 Nov 2023 18:05:21 +0100 + FeedID + + http://example.com/item1 + Title1 + Content1 + + + +``` + +### Consuming a Feed + +```csharp +using System.ServiceModel.Syndication; +using System.Xml; + +string feedUrl = "https://devblogs.microsoft.com/dotnet/feed/"; +using XmlReader reader = XmlReader.Create(feedUrl); + +// Read the feed using Atom10FeedFormatter. +SyndicationFeed feed = SyndicationFeed.Load(reader); + +Console.WriteLine($"Feed Title: {feed.Title.Text}"); +Console.WriteLine("Feed Items:"); + +// Iterate through the feed items and display the title and a brief summary of each. +foreach (SyndicationItem item in feed.Items) +{ + Console.WriteLine($"Title: {item.Title.Text}"); + Console.WriteLine($"Published Date: {item.PublishDate.DateTime}"); +} + +/* + * This code produces the following output: + * + * Feed Title: .NET Blog + * Feed Items: + * - Title: Join us for the Great .NET 8 Hack + * Published Date: 07/11/2023 18:05:00 + * - Title: The convenience of System.IO + * Published Date: 06/11/2023 18:05:00 + */ +``` + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `System.ServiceModel.Syndication.SyndicationFeed` +* `System.ServiceModel.Syndication.SyndicationItem` +* `System.ServiceModel.Syndication.Rss20FeedFormatter` +* `System.ServiceModel.Syndication.Atom10FeedFormatter` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) - -## Related Packages - - +* [Conceptual documentation](https://learn.microsoft.com/dotnet/framework/wcf/feature-details/how-to-create-a-basic-rss-feed) +* [API documentation](https://learn.microsoft.com/dotnet/api/system.servicemodel.syndication) ## Feedback & Contributing -System.ServiceModel.Syndication is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +System.ServiceModel.Syndication is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). From ae03b5550917dc7754de08488adeb1958a3e1450 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= Date: Wed, 6 Dec 2023 21:22:18 +0100 Subject: [PATCH 22/23] Provide Threading.AccessControl package readme (#94586) --- .../src/PACKAGE.md | 92 ++++++++++++++++--- 1 file changed, 78 insertions(+), 14 deletions(-) diff --git a/src/libraries/System.Threading.AccessControl/src/PACKAGE.md b/src/libraries/System.Threading.AccessControl/src/PACKAGE.md index fd3a0e78cf295..5d5fa9b740f70 100644 --- a/src/libraries/System.Threading.AccessControl/src/PACKAGE.md +++ b/src/libraries/System.Threading.AccessControl/src/PACKAGE.md @@ -2,43 +2,107 @@ - +System.Threading.AccessControl provides types that enable you to control access to threading synchronization primitives. +This includes the ability to control access to Mutexes, Semaphores, and Events using Windows Access Control Lists (ACLs). ## Key Features -* -* -* +* Extension methods to allow ACL modifications on `Mutex`, `Semaphore`, and `EventWaitHandle`. +* Simplified security management for threading synchronization objects. ## How to Use +```csharp +using System.Security.AccessControl; +using System.Security.Principal; + +// Create a string representing the current user. +string user = $"{Environment.UserDomainName}\\{Environment.UserName}"; + +// Create a security object that grants no access +MutexSecurity mutexSecurity = new MutexSecurity(); + +// Add a rule that grants the current user the right to enter or release the mutex +MutexAccessRule rule = new MutexAccessRule(user, MutexRights.Synchronize | MutexRights.Modify, AccessControlType.Allow); +mutexSecurity.AddAccessRule(rule); + +// Add a rule that denies the current user the right to change permissions on the mutex +rule = new MutexAccessRule(user, MutexRights.ChangePermissions, AccessControlType.Deny); +mutexSecurity.AddAccessRule(rule); + +// Display the rules in the security object +ShowSecurity(mutexSecurity); + +// Add a rule that allows the current user the right to read permissions on the mutex +// This rule is merged with the existing Allow rule +rule = new MutexAccessRule(user, MutexRights.ReadPermissions, AccessControlType.Allow); +mutexSecurity.AddAccessRule(rule); + +// Display the rules in the security object +ShowSecurity(mutexSecurity); + +static void ShowSecurity(MutexSecurity security) +{ + Console.WriteLine("\nCurrent access rules:\n"); + + foreach (MutexAccessRule ar in security.GetAccessRules(true, true, typeof(NTAccount))) + { + Console.WriteLine($" User: {ar.IdentityReference}"); + Console.WriteLine($" Type: {ar.AccessControlType}"); + Console.WriteLine($" Rights: {ar.MutexRights}"); + Console.WriteLine(); + } +} + +/* + * This code example produces output similar to following: + * + * Current access rules: + * + * User: TestDomain\TestUser + * Type: Deny + * Rights: ChangePermissions + * + * User: TestDomain\TestUser + * Type: Allow + * Rights: Modify, Synchronize + * + * + * Current access rules: + * + * User: TestDomain\TestUser + * Type: Deny + * Rights: ChangePermissions + * + * User: TestDomain\TestUser + * Type: Allow + * Rights: Modify, ReadPermissions, Synchronize + */ +``` + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `System.Threading.EventWaitHandleAcl` +* `System.Threading.MutexAcl` +* `System.Threading.SemaphoreAcl` +* `System.Threading.ThreadingAclExtensions` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) - -## Related Packages - - +* [API documentation](https://learn.microsoft.com/dotnet/api/system.threading?view=dotnet-plat-ext-7.0) ## Feedback & Contributing -System.Threading.AccessControl is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +System.Threading.AccessControl is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). From 0845dbdbcaba11880258f473c8c7c585dc3c3d8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Hompus?= Date: Fri, 8 Dec 2023 18:23:58 +0100 Subject: [PATCH 23/23] Provide System.Threading.RateLimiting package readme (#94583) * Provide Threading.RateLimiting package readme --- .../src/PACKAGE.md | 134 ++++++++++++++++-- 1 file changed, 125 insertions(+), 9 deletions(-) diff --git a/src/libraries/System.Threading.RateLimiting/src/PACKAGE.md b/src/libraries/System.Threading.RateLimiting/src/PACKAGE.md index 381d588124a3d..a1f2f3111b564 100644 --- a/src/libraries/System.Threading.RateLimiting/src/PACKAGE.md +++ b/src/libraries/System.Threading.RateLimiting/src/PACKAGE.md @@ -2,36 +2,152 @@ - +Provides a set of types that enable application developers to control the rate of operations. +This can be used to ensure that applications do not exceed certain limits when interacting with resources or services. ## Key Features -* -* +* Flexible rate-limiting primitives that can be applied to various scenarios. +* Supports token bucket, fixed window, and sliding window strategies. * ## How to Use +This is an example of an HttpClient that does client side rate limiting. + +Define a rate limiter. + +```csharp +internal sealed class ClientSideRateLimitedHandler : DelegatingHandler, IAsyncDisposable +{ + private readonly RateLimiter _rateLimiter; + + public ClientSideRateLimitedHandler(RateLimiter limiter) + : base(new HttpClientHandler()) + { + _rateLimiter = limiter; + } + + // Override the SendAsync method to apply rate limiting. + protected override async Task SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) + { + // Try to acquire a token from the rate limiter. + using RateLimitLease lease = await _rateLimiter.AcquireAsync(permitCount: 1, cancellationToken); + + // If a token is acquired, proceed with sending the request. + if (lease.IsAcquired) + { + return await base.SendAsync(request, cancellationToken); + } + + // If no token could be acquired, simulate a 429 Too Many Requests response. + var response = new HttpResponseMessage(HttpStatusCode.TooManyRequests); + + // Add a 'Retry-After' header if the rate limiter provides a retry delay. + if (lease.TryGetMetadata(MetadataName.RetryAfter, out TimeSpan retryAfter)) + { + response.Headers.Add("Retry-After", ((int)retryAfter.TotalSeconds).ToString(NumberFormatInfo.InvariantInfo)); + } + + return response; + } + + // Implement IAsyncDisposable to allow for asynchronous cleanup of resources. + public async ValueTask DisposeAsync() + { + // Dispose of the rate limiter asynchronously. + await _rateLimiter.DisposeAsync().ConfigureAwait(false); + + // Call the base Dispose method. + Dispose(disposing: false); + + // Suppress finalization. + GC.SuppressFinalize(this); + } + + // Dispose pattern to clean up the rate limiter. + protected override void Dispose(bool disposing) + { + base.Dispose(disposing); + + if (disposing) + { + // Synchronously dispose of the rate limiter if disposing is true. + _rateLimiter.Dispose(); + } + } +} +``` + +Using the rate limiter. + +```csharp +using System.Globalization; +using System.Net; +using System.Threading.RateLimiting; + +// Initialize the rate limiter options. +// TokenLimit: Maximum number of tokens that can be acquired at once. +// QueueProcessingOrder: The order in which queued requests will be processed. +// QueueLimit: Maximum number of queued requests. +// ReplenishmentPeriod: How often tokens are replenished. +// TokensPerPeriod: Number of tokens added each period. +// AutoReplenishment: If true, tokens are replenished automatically in the background. +var options = new TokenBucketRateLimiterOptions +{ + TokenLimit = 4, + QueueProcessingOrder = QueueProcessingOrder.OldestFirst, + QueueLimit = 2, + ReplenishmentPeriod = TimeSpan.FromMilliseconds(1), + TokensPerPeriod = 2, + AutoReplenishment = true +}; + +// Create a new instance of the TokenBucketRateLimiter with the defined options. +TokenBucketRateLimiter tokenBucketRateLimiter = new TokenBucketRateLimiter(options); + +// A custom HttpMessageHandler that limits the rate of outgoing HTTP requests. +ClientSideRateLimitedHandler clientsideRateLimitedHandler = new ClientSideRateLimitedHandler(tokenBucketRateLimiter); + +// Create an HttpClient that uses the rate-limited handler. +using HttpClient client = new HttpClient(clientsideRateLimitedHandler); + +// Generate a list of dummy URLs for testing the rate limiter. +var oneHundredUrls = Enumerable.Range(0, 100).Select(i => $"https://example.com?iteration={i:00}"); + +// Issue concurrent HTTP GET requests using the HttpClient. +// The rate limiter will control how many requests are sent based on the defined limits. +await Parallel.ForEachAsync(oneHundredUrls.Take(0..100), async (url, cancellationToken) => +{ + using HttpResponseMessage response = await client.GetAsync(url, cancellationToken); + Console.WriteLine($"URL: {url}, HTTP status code: {response.StatusCode} ({(int)response.StatusCode})"); +}); +``` + ## Main Types The main types provided by this library are: -* `` -* `` -* `` +* `System.Threading.RateLimiting.RateLimiter` +* `System.Threading.RateLimiting.ConcurrencyLimiter` +* `System.Threading.RateLimiting.FixedWindowRateLimiter` +* `System.Threading.RateLimiting.ReplenishingRateLimiter` +* `System.Threading.RateLimiting.SlidingWindowRateLimiter` +* `System.Threading.RateLimiting.TokenBucketRateLimiter` +* `System.Threading.RateLimiting.PartitionedRateLimiter` ## Additional Documentation -* [Conceptual documentation](https://learn.microsoft.com/dotnet/standard/serialization/**LIBRARYNAME**/overview) -* [API documentation](https://learn.microsoft.com/dotnet/api/**LIBRARYNAME**) +* [Conceptual documentation](https://learn.microsoft.com/dotnet/core/extensions/http-ratelimiter) +* [API documentation](https://learn.microsoft.com/dotnet/api/system.threading.ratelimiting) ## Related Packages @@ -41,4 +157,4 @@ The main types provided by this library are: -System.Threading.RateLimiting is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime). \ No newline at end of file +System.Threading.RateLimiting is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/runtime).