Skip to content

Commit

Permalink
Adding PACKAGE.md to System.Runtime.Caching package (#90701)
Browse files Browse the repository at this point in the history
* Adding PACKAGE.md to System.Runtime.Caching package

* add Remarks

* move PACKAGE.md to src folder

* update per PR feedback

* add important block
  • Loading branch information
HongGit authored and radical committed Aug 21, 2023
1 parent 30f1200 commit 2721f80
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions src/libraries/System.Runtime.Caching/src/PACKAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## About

[System.Runtime.Caching](https://learn.microsoft.com/en-us/dotnet/api/system.runtime.caching?view=dotnet-plat-ext-7.0) ([NuGet package](https://www.nuget.org/packages/System.Runtime.Caching/)) is a packaged set of simple caching API's derived from those of the same namespace available in .Net Framework since 4.0. This package is intended for use as a bridge when porting .Net Framework applications to .Net Core.

This `System.Runtime.Caching` package can be used with any [.NET implementation](/dotnet/standard/net-standard#net-implementation-support) that targets .NET Standard 2.0 or later. For example:
* .NET Core 3.1 or later.
* .Net Framework 4.5 or later.
* .Net 5.0 or late

[Microsoft.Extensions.Caching.Memory](https://www.nuget.org/packages/Microsoft.Extensions.Caching.Memory/)/[IMemoryCache](https://learn.microsoft.com/en-us/aspnet/core/performance/caching/memory?view=aspnetcore-7.0) 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](https://learn.microsoft.com/en-us/aspnet/core/fundamentals/dependency-injection?view=aspnetcore-7.0).

> > [!IMPORTANT]
> Use `System.Runtime.Caching`/`MemoryCache` as a compatibility bridge when porting code from .NET 4.x to .NET Core.

## Main Types

The main types provided by this library are:

* `System.Runtime.Caching.MemoryCache`

## Remarks

[MemoryCache.PhysicalMemoryLimit](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.

## 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).

0 comments on commit 2721f80

Please sign in to comment.