Skip to content

Commit 1db782d

Browse files
committed
Update Readme to v2.0
+ Honour package rename from Polly.Caching.MemoryCache, to Polly.Caching.Memory. + Update package target descriptions. + Add credits
1 parent ce3f262 commit 1db782d

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

README.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,53 @@
1-
# Polly.Caching.MemoryCache
1+
# Polly.Caching.Memory
22

3-
This repo contains the MemoryCache plugin for the [Polly](https://github.com/App-vNext/Polly) [Cache policy](https://github.com/App-vNext/Polly/wiki/Cache). It targets .NET 4.0, .NET 4.5 and .NET Standard 1.3.
3+
This repo contains the MemoryCache plugin for the [Polly](https://github.com/App-vNext/Polly) [Cache policy](https://github.com/App-vNext/Polly/wiki/Cache). The current version targets .NET Standard 1.3 and .NET Standard 2.0.
44

5-
[![NuGet version](https://badge.fury.io/nu/Polly.Caching.MemoryCache.svg)](https://badge.fury.io/nu/Polly.Caching.MemoryCache) [![Build status](https://ci.appveyor.com/api/projects/status/pgd89nfdr9u4ig8m?svg=true)](https://ci.appveyor.com/project/joelhulen/polly-caching-memorycache) [![Slack Status](http://www.pollytalk.org/badge.svg)](http://www.pollytalk.org)
5+
[![NuGet version](https://badge.fury.io/nu/Polly.Caching.Memory.svg)](https://badge.fury.io/nu/Polly.Caching.Memory) [![Build status](https://ci.appveyor.com/api/projects/status/pgd89nfdr9u4ig8m?svg=true)](https://ci.appveyor.com/project/joelhulen/polly-caching-Memory) [![Slack Status](http://www.pollytalk.org/badge.svg)](http://www.pollytalk.org)
66

77
## What is Polly?
88

9-
[Polly](https://github.com/App-vNext/Polly) is a .NET resilience and transient-fault-handling library that allows developers to express policies such as Retry, Circuit Breaker, Timeout, Bulkhead Isolation, Cache aside and Fallback in a fluent and thread-safe manner. Polly targets .NET 4.0, .NET 4.5 and .NET Standard 1.1.
9+
[Polly](https://github.com/App-vNext/Polly) is a .NET resilience and transient-fault-handling library that allows developers to express policies such as Retry, Circuit Breaker, Timeout, Bulkhead Isolation, Cache aside and Fallback in a fluent and thread-safe manner. Polly targets .NET Standard 1.1 and .NET Standrad 2.0.
1010

1111
Polly is a member of the [.NET Foundation](https://www.dotnetfoundation.org/about)!
1212

1313
**Keep up to date with new feature announcements, tips & tricks, and other news through [www.thepollyproject.org](http://www.thepollyproject.org)**
1414

1515
![](https://raw.github.com/App-vNext/Polly/master/Polly-Logo.png)
1616

17-
# Installing Polly.Caching.MemoryCache via NuGet
17+
# Installing Polly.Caching.Memory via NuGet
1818

19-
Install-Package Polly.Caching.MemoryCache
19+
Install-Package Polly.Caching.Memory
2020

21-
You can install the Strongly Named version via:
22-
23-
Install-Package Polly.Caching.MemoryCache-Signed
2421

2522
# Supported targets
2623

27-
Polly.Caching.MemoryCache supports .NET4.0, .NET4.5 and .NetStandard 1.3.
24+
Polly.Caching.Memory >= v2.0 supports .NET Standard 1.3 and .NET Standard 2.0.
25+
26+
Polly.Caching.MemoryCache <v2.0 supports .NET4.0, .NET4.5 and .NetStandard 1.3
2827

2928
## Dependencies
3029

31-
Polly.Caching.MemoryCache works with Polly v5.9.0 and above.
30+
Polly.Caching.Memory >= v2.0 works with Polly v6.0.1 and above.
31+
32+
Polly.Caching.MemoryCache <v2.0 works with Polly v5.9.0 and above.
3233

33-
# How to use the Polly.Caching.MemoryCache plugin
34+
# How to use the Polly.Caching.Memory plugin
3435

3536
```csharp
36-
// (1a): Create a MemoryCacheProvider instance in the .NET Framework, using the Polly.Caching.MemoryCache nuget package.
37+
// (1a): Create a MemoryCacheProvider instance in the .NET Framework, using the Polly.Caching.Memory nuget package.
3738
// (full namespaces and types only shown here for disambiguation)
38-
Polly.Caching.MemoryCache.MemoryCacheProvider memoryCacheProvider
39-
= new Polly.Caching.MemoryCache.MemoryCacheProvider(System.Runtime.Caching.MemoryCache.Default);
39+
Polly.Caching.Memory.MemoryCacheProvider memoryCacheProvider
40+
= new Polly.Caching.Memory.MemoryCacheProvider(System.Runtime.Caching.MemoryCache.Default);
4041

4142
// Or (1b): Create a MemoryCacheProvider instance in .NET Core / .NET Standard.
4243
// (full namespaces and types only shown here for disambiguation)
4344
// NB Only if you want to create your own Microsoft.Extensions.Caching.Memory.MemoryCache instance:
4445
Microsoft.Extensions.Caching.Memory.IMemoryCache memoryCache
4546
= new Microsoft.Extensions.Caching.Memory.MemoryCache(new Microsoft.Extensions.Caching.Memory.MemoryCacheOptions());
46-
Polly.Caching.MemoryCache.MemoryCacheProvider memoryCacheProvider
47-
= new Polly.Caching.MemoryCache.MemoryCacheProvider(memoryCache);
47+
Polly.Caching.Memory.MemoryCacheProvider memoryCacheProvider
48+
= new Polly.Caching.Memory.MemoryCacheProvider(memoryCache);
4849

49-
// (2) Create a Polly cache policy using that Polly.Caching.MemoryCache.MemoryCacheProvider instance.
50+
// (2) Create a Polly cache policy using that Polly.Caching.Memory.MemoryCacheProvider instance.
5051
var cachePolicy = Policy.Cache(memoryCacheProvider, TimeSpan.FromMinutes(5));
5152

5253

@@ -64,7 +65,7 @@ public class Startup
6465
{
6566
services.AddMemoryCache();
6667
services.AddSingleton<Polly.Registry.IPolicyRegistry<string>, Polly.Registry.PolicyRegistry>();
67-
services.AddSingleton<Polly.Caching.ISyncCacheProvider, Polly.Caching.MemoryCache.MemoryCacheProvider>(); // Or: IAsyncCacheProvider
68+
services.AddSingleton<Polly.Caching.ISyncCacheProvider, Polly.Caching.Memory.MemoryCacheProvider>(); // Or: IAsyncCacheProvider
6869
// ...
6970
}
7071

@@ -99,6 +100,7 @@ For details of changes by release see the [change log](CHANGELOG.md).
99100
* [@reisenberger](https://github.com/reisenberger) - MemoryCache implementation
100101
* [@seanfarrow](https://github.com/seanfarrow) and [@reisenberger](https://github.com/reisenberger) - Initial caching architecture in the main Polly repo
101102
* [@kesmy](https://github.com/kesmy) - original structuring of the build for msbuild15, in the main Polly repo
103+
* [@seanfarrow](https://github.com/seanfarrow) - v2.0 update to Signed packages only to correspond with Polly v6.0.1
102104

103105

104106
# Instructions for Contributing

0 commit comments

Comments
 (0)