-
Notifications
You must be signed in to change notification settings - Fork 4.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add package readmes #91210
Merged
Merged
Add package readmes #91210
Changes from 58 commits
Commits
Show all changes
62 commits
Select commit
Hold shift + click to select a range
5098dde
Add package readmes
ViktorHofer 7aaf419
System.Diagnostics.EventLog
carlossanlop dc40124
System.Diagnostics.PerformanceCounter
carlossanlop 32c9b03
Add package readme for System.Speech
ericstj 538a3bc
Fill Microsoft.Extensions.Logging.Abstraction doc
tarekgh 3f9bf8e
Fill Microsoft.Extensions.Logging doc
tarekgh f582265
Fill Microsoft.Extensions.Logging.Console doc
tarekgh 1cc11d4
Fill Microsoft.Extensions.Logging.Debug doc
tarekgh ceecbc0
Merge remote-tracking branch 'upstream/main' into InSourcePackageReadme
stephentoub 753a352
Add Microsoft.Bcl.Async package.md details
stephentoub e20281d
Add System.Threading.Channels package.md details
stephentoub 01b831e
Fill Microsoft.Extensions.Primitives doc
tarekgh a859686
Merge branch 'InSourcePackageReadme' of https://github.com/dotnet/run…
tarekgh 628dd0b
Remove trailing spaces from Speech doc file
tarekgh a6c50e0
Fill Microsoft.Extensions.Options doc
tarekgh b642db2
Fill System.Text.Encoding.CodePages doc
tarekgh e0358bb
Add System.IO.Ports
krwq 6cafb45
Add System.Net.Http.Json README
eiriktsarpalis 9217e37
Readme for WinHttpHandler
antonfirsov 5046b1f
Fill Microsoft.Extensions.Options.ConfigurationExtensions doc
tarekgh e2442e5
Merge branch 'InSourcePackageReadme' of https://github.com/dotnet/run…
tarekgh d722555
Update Microsoft.Extensions.Http
CarnaViire 9c1d795
Fill Microsoft.Bcl.TimeProvider doc
tarekgh 43303db
Merge branch 'InSourcePackageReadme' of https://github.com/dotnet/run…
tarekgh 5bfc51c
Add Microsoft.Extensions.Caching.Memory package.md details
jozkee e420125
Add Microsoft.Extensions.DependencyInjection
steveharter 941ea55
Add Microsoft.Extensions.DependencyInjections.Abstractions
steveharter 7e3b194
Add Microsoft.Extensions.Hosting
steveharter 8621b39
Add Microsoft.Extensions.Hosting.WindowsServices
steveharter a53318d
Update PACKAGE.md for System.DirectoryServices
buyaa-n cfac502
Apply suggestions from code review
buyaa-n c71c61a
Update System.DirectoryServices.AccountManagement PACKAGE.md
buyaa-n 53b5112
Remove extra space
buyaa-n 1f54dd0
space
danmoseley cbbcedb
Add Microsoft.Extensions.Hosting.Abstractions
steveharter 4cecddb
Update PACKAGE.md
steveharter e987cd0
Update PACKAGE.md
steveharter 1c9f82b
Update Hosting
steveharter 881a662
Update Hosting
steveharter 5bbb977
Remove unnecessary brackets
buyaa-n 2444a7f
add oledb and odbc
danmoseley 342df48
tweak
danmoseley b7515e9
Update src/libraries/System.Speech/src/PACKAGE.md
danmoseley ea34d03
Update src/libraries/Microsoft.Extensions.Http/src/PACKAGE.md
danmoseley c88b6db
Update src/libraries/System.Speech/src/PACKAGE.md
danmoseley 022599f
Apply suggestions from code review
danmoseley 228cba0
Apply suggestions for System.Diagnostics.EventLog & PerformanceCounter
carlossanlop b5db5b6
added Bcl.Numerics
michaelgsharp 545dca2
Fill template for Microsoft.Extensions.Configuration & Abstractions
ericstj c4d3e72
Add Microsoft.Extensions.Configuration.Binder readme.
ericstj 3046549
Remove undocumented P2 package readmes
ViktorHofer d6f6188
Update Feedback library name markdown style
ViktorHofer ea036c5
Remove en-US culture from links
ViktorHofer 5b57763
Replace important markdown tag with bold
ViktorHofer 513cf12
MathF PR feedback
ViktorHofer acad01b
Add System.Management packag readme
ViktorHofer 921d8be
Fix trailing whitespace
ViktorHofer d1176ac
Add ServiceController package readme
ViktorHofer 52e5715
Clean-up
ViktorHofer aa53051
More clean-up
ViktorHofer c387565
ConfigurationManager clean-up
ViktorHofer ab8419a
Last clean-up
ViktorHofer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
64 changes: 64 additions & 0 deletions
64
src/libraries/Microsoft.Bcl.AsyncInterfaces/src/PACKAGE.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
## About | ||
|
||
As of C# 8, the C# language has support for producing and consuming asynchronous iterators. The library types in support of those features are available in .NET Core 3.0 and newer as well as in .NET Standard 2.1. This library provides the necessary definitions of those types to support these language features on .NET Framework and on .NET Standard 2.0. This library is not necessary nor recommended when targeting versions of .NET that include the relevant support. | ||
|
||
## Key Features | ||
|
||
<!-- The key features of this package --> | ||
|
||
* Enables the use of C# async iterators on older .NET platforms | ||
|
||
## How to Use | ||
|
||
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package --> | ||
|
||
```C# | ||
using System; | ||
using System.Collections.Generic; | ||
using System.Threading.Tasks; | ||
|
||
internal static class Program | ||
{ | ||
private static async Task Main() | ||
{ | ||
Console.WriteLine("Starting..."); | ||
await foreach (var value in GetValuesAsync()) | ||
{ | ||
Console.WriteLine(value); | ||
} | ||
Console.WriteLine("Finished!"); | ||
|
||
static async IAsyncEnumerable<int> GetValuesAsync() | ||
{ | ||
for (int i = 0; i < 10; i++) | ||
{ | ||
await Task.Delay(TimeSpan.FromSeconds(1)); | ||
yield return i; | ||
} | ||
} | ||
} | ||
} | ||
``` | ||
|
||
## Main Types | ||
|
||
<!-- The main types provided in this library --> | ||
|
||
The main types provided by this library are: | ||
|
||
* `IAsyncEnumerable<T>` | ||
* `IAsyncEnumerator<T>` | ||
* `IAsyncDisposable<T>` | ||
|
||
## Additional Documentation | ||
|
||
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. --> | ||
|
||
* [C# Feature Specification](https://learn.microsoft.com/dotnet/csharp/language-reference/proposals/csharp-8.0/async-streams) | ||
* [Walkthrough article](https://learn.microsoft.com/archive/msdn-magazine/2019/november/csharp-iterating-with-async-enumerables-in-csharp-8) | ||
|
||
## Feedback & Contributing | ||
|
||
<!-- How to provide feedback on this package and contribute to it --> | ||
|
||
Microsoft.Bcl.AsyncInterfaces 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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
## About | ||
|
||
As of .NET Core 2.0 and .NET Standard 2.1, the C# language has support for math (System.MathF) functions with floats. This library provides the necessary definitions of those types to support these language features on .NET Framework and on .NET Standard 2.0. This library is not necessary nor recommended when targeting versions of .NET that include the relevant support. | ||
|
||
## Key Features | ||
|
||
<!-- The key features of this package --> | ||
|
||
* Enables the use of MathF on older .NET platforms | ||
|
||
|
||
## How to Use | ||
|
||
```C# | ||
using System; | ||
|
||
internal static class Program | ||
{ | ||
private static async Task Main() | ||
{ | ||
Console.WriteLine(MathF.Max(1f, 5f)); // returns 5f | ||
} | ||
} | ||
``` | ||
|
||
## Main Types | ||
|
||
<!-- The main types provided in this library --> | ||
|
||
The main types provided by this library are: | ||
|
||
* `System.MathF` | ||
|
||
## Additional Documentation | ||
|
||
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. --> | ||
|
||
* [API documentation](https://learn.microsoft.com/dotnet/api/system.mathf) | ||
|
||
## Feedback & Contributing | ||
|
||
<!-- How to provide feedback on this package and contribute to it --> | ||
|
||
Microsoft.Bcl.Numerics 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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
## About | ||
|
||
Microsoft.Bcl.TimeProvider provides time abstraction support for apps targeting .NET 7 and earlier, as well as those intended for the .NET Framework. For apps targeting .NET 8 and newer versions, referencing this package is unnecessary, as the types it contains are already included in the .NET 8 and higher platform versions. | ||
|
||
## Key Features | ||
|
||
* Provides a common abstraction for time-related operations. | ||
|
||
## How to Use | ||
|
||
```csharp | ||
using System; | ||
|
||
// A class that uses TimeProvider to get the current time in Utc coordinates | ||
public class UtcClock | ||
{ | ||
private readonly TimeProvider _timeProvider; | ||
|
||
// Constructor that takes a TimeProvider as a dependency | ||
public Clock(TimeProvider timeProvider) | ||
{ | ||
_timeProvider = timeProvider; | ||
} | ||
|
||
// A method that returns the current time as a string | ||
public string GetTime() | ||
{ | ||
return _timeProvider.GetLocalNow().ToString("HH:mm:ss"); | ||
} | ||
} | ||
|
||
// A class that inherits from TimeProvider and overrides the GetLocalNow method | ||
public class UtcTimeProvider : TimeProvider | ||
{ | ||
// Override the GetLocalNow method to always return UTC time | ||
public override DateTimeOffset GetLocalNow() | ||
{ | ||
return TimeProvider.System.GetUtcNow(); | ||
} | ||
} | ||
|
||
``` | ||
|
||
## Main Types | ||
|
||
The main types provided by this library are: | ||
|
||
* `TimeProvider` | ||
* `TimeProviderTaskExtensions` | ||
|
||
## Additional Documentation | ||
|
||
* [API documentation](https://learn.microsoft.com/dotnet/api/system.timeprovider) | ||
|
||
|
||
## Feedback & Contributing | ||
|
||
Microsoft.Bcl.TimeProvider 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). |
89 changes: 89 additions & 0 deletions
89
src/libraries/Microsoft.Extensions.Caching.Memory/src/PACKAGE.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
## About | ||
|
||
<!-- A description of the package and where one can find more documentation --> | ||
|
||
Provides implementations for local and distributed in-memory cache. It stores and retrieves data in a fast and efficient way. | ||
|
||
## Key Features | ||
|
||
<!-- The key features of this package --> | ||
|
||
* A concrete implementation of the IMemoryCache interface, which represents a local in-memory cache that stores and retrieves data in a fast and efficient way | ||
* A distributed cache that supports higher scale-out than local cache | ||
* Expiration and eviction policies for its entries | ||
* Entry prioritization for when the cache size limit is exceeded and needs to be compacted by entry eviction | ||
* Track of cache statictics | ||
|
||
## How to Use | ||
|
||
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package --> | ||
|
||
Use Microsoft.Extensions.Caching.Memory over System.Runtime.Caching when working with ASP.NET Core as it provides better integration support. For example, IMemoryCache works natively with ASP.NET Core dependency injection. | ||
|
||
Local in-memory serialization: | ||
```csharp | ||
using Microsoft.Extensions.Caching.Memory; | ||
|
||
using MemoryCache cache = new(new MemoryCacheOptions()); | ||
|
||
object valueToCache = new(); | ||
string key = "key"; | ||
|
||
using (ICacheEntry entry = cache.CreateEntry(key)) | ||
{ | ||
// Entries are committed after they are disposed therefore it does not exist yet. | ||
Console.WriteLine($"Exists: {cache.TryGetValue(key, out _)}\n"); | ||
|
||
entry.Value = valueToCache; | ||
entry.SlidingExpiration = TimeSpan.FromSeconds(2); | ||
} | ||
|
||
bool exists = cache.TryGetValue(key, out object? cachedValue); | ||
Console.WriteLine($"Exists: {exists}" ); | ||
Console.WriteLine($"cachedValue is valueToCache? {object.ReferenceEquals(cachedValue, valueToCache)}\n"); | ||
|
||
Console.WriteLine("Wait for the sliding expiration..."); | ||
Thread.Sleep(TimeSpan.FromSeconds(2)); | ||
|
||
Console.WriteLine("Exists: " + cache.TryGetValue(key, out _)); | ||
|
||
// You can also use the acceleration extensions to set and get entries | ||
string key2 = "key2"; | ||
object value2 = new(); | ||
|
||
cache.Set("key2", value2); | ||
|
||
object? cachedValue2 = cache.Get(key2); | ||
Console.WriteLine($"cachedValue2 is value2? {object.ReferenceEquals(cachedValue2, value2)}"); | ||
``` | ||
|
||
## Main Types | ||
|
||
<!-- The main types provided in this library --> | ||
|
||
The main types provided by this library are: | ||
|
||
* `Microsoft.Extensions.Caching.Memory.MemoryCache` | ||
* `Microsoft.Extensions.Caching.Memory.MemoryCacheOptions` | ||
* `Microsoft.Extensions.Caching.Distributed.MemoryDistributedCache` | ||
* `Microsoft.Extensions.Caching.Memory.MemoryDistributedCacheOptions` | ||
|
||
## Additional Documentation | ||
|
||
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. --> | ||
|
||
* [Conceptual documentation](https://learn.microsoft.com/dotnet/core/extensions/caching) | ||
* [Cache in-memory in ASP.NET Core](https://learn.microsoft.com/aspnet/core/performance/caching/memory) | ||
* [API documentation](https://learn.microsoft.com/dotnet/api/microsoft.extensions.caching.memory) | ||
|
||
## Related Packages | ||
|
||
<!-- The related packages associated with this package --> | ||
|
||
[Microsoft.Extensions.Caching.Abstractions](https://www.nuget.org/packages/Microsoft.Extensions.Caching.Abstractions) | ||
|
||
## Feedback & Contributing | ||
|
||
<!-- How to provide feedback on this package and contribute to it --> | ||
|
||
Microsoft.Extensions.Caching.Memory 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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ericstj @adamsitnik PTAL.