Skip to content
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

Adding PACKAGE.md to System.Runtime.Caching package #90701

Merged
merged 5 commits into from
Aug 21, 2023
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions src/libraries/System.Runtime.Caching/src/PACKAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## About

[System.Runtime.Caching](https://learn.microsoft.com/en-us/dotnet/api/system.runtime.caching?view=dotnet-plat-ext-7.0)/[System.Runtime.Caching.MemoryCache](https://learn.microsoft.com/en-us/dotnet/api/system.runtime.caching.memorycache?view=dotnet-plat-ext-7.0) ([NuGet package](https://www.nuget.org/packages/System.Runtime.Caching/)) can be used with:
HongGit marked this conversation as resolved.
Show resolved Hide resolved
HongGit marked this conversation as resolved.
Show resolved Hide resolved

* .NET Standard 2.0 or later.
* Any [.NET implementation](/dotnet/standard/net-standard#net-implementation-support) that targets .NET Standard 2.0 or later. For example, ASP.NET Core 3.1 or later.
HongGit marked this conversation as resolved.
Show resolved Hide resolved
* .NET Framework 4.5 or later.
HongGit marked this conversation as resolved.
Show resolved Hide resolved

[Microsoft.Extensions.Caching.Memory](https://www.nuget.org/packages/Microsoft.Extensions.Caching.Memory/)/`IMemoryCache` (described in this article) is recommended over `System.Runtime.Caching`/`MemoryCache` because it's better integrated into ASP.NET Core. For example, `IMemoryCache` works natively with ASP.NET Core [dependency injection](xref:fundamentals/dependency-injection).
HongGit marked this conversation as resolved.
Show resolved Hide resolved
HongGit marked this conversation as resolved.
Show resolved Hide resolved

Use `System.Runtime.Caching`/`MemoryCache` as a compatibility bridge when porting code from ASP.NET 4.x to ASP.NET Core.
HongGit marked this conversation as resolved.
Show resolved Hide resolved

## Key Features

* MemoryCache feature represents the type that implements an in-memory cache.

HongGit marked this conversation as resolved.
Show resolved Hide resolved
## Main Types

The main types provided by this library are:

* `System.Runtime.Caching.MemmoryCache`
HongGit marked this conversation as resolved.
Show resolved Hide resolved

## Remarks

[MemoryCache.PhysicalMemeoryLimit](https://learn.microsoft.com/en-us/dotnet/api/system.runtime.caching.memorycache.physicalmemorylimit?view=dotnet-plat-ext-7.0) property is only supported on windows.
HongGit marked this conversation as resolved.
Show resolved Hide resolved

## Addtional Documentation

* [Caching in .NET](https://learn.microsoft.com/en-us/dotnet/core/extensions/caching)
* [Cache in-memory in ASP.NET Core](https://learn.microsoft.com/en-us/aspnet/core/performance/caching/memory?view=aspnetcore-7.0 )

## Related Packages

* [Microsoft.Extensions.Caching.Memory](https://www.nuget.org/packages/Microsoft.Extensions.Caching.Memory/)

## Feedback & Contributing

System.Runtime.Caching 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).