Update documentation for breaking change

Author: leonibr

Extensions.Caching.PostgreSql/Community.Microsoft.Extensions.Caching.PostgreSql.csproj

@@ -4,7 +4,7 @@
     <AssemblyName>Community.Microsoft.Extensions.Caching.PostgreSql</AssemblyName>
     <RootNamespace>Community.Microsoft.Extensions.Caching.PostgreSql</RootNamespace>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
-    <Version>2.0.0</Version>
+    <Version>3.0.0</Version>
     <Authors>Ashley Marques</Authors>
     <Company />
     <Description>DistributedCache using postgres</Description>

Extensions.Caching.PostgreSql/PostgreSqlCache.cs

@@ -11,6 +11,7 @@ internal sealed class PostgreSqlCache : IDistributedCache
         private readonly IDatabaseOperations _dbOperations;
         private readonly TimeSpan _defaultSlidingExpiration;
 
+        [Obsolete("Do not use constructor directly instead pull IDistributedCache from DI. For this add 'services.AddDistributedPostgreSqlCache'")]
         public PostgreSqlCache(
             IOptions<PostgreSqlCacheOptions> options,
             IDatabaseOperations databaseOperations,

PostgresSqlCacheSolution.sln

@@ -9,6 +9,14 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Community.Microsoft.Extensi
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PostgreSqlCacheSample", "PostgreSqlCacheSample\PostgreSqlCacheSample.csproj", "{248946AE-B9BF-4E27-BB8B-B8967C703981}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WebSample", "WebSample\WebSample.csproj", "{CA8FFB11-C327-48C1-94BA-24B9D61021FD}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{548EB70F-C803-4B22-A992-131B9A5E1446}"
+	ProjectSection(SolutionItems) = preProject
+		README.md = README.md
+		sample_project.gif = sample_project.gif
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -43,12 +51,25 @@ Global
 		{248946AE-B9BF-4E27-BB8B-B8967C703981}.Release|x64.Build.0 = Release|Any CPU
 		{248946AE-B9BF-4E27-BB8B-B8967C703981}.Release|x86.ActiveCfg = Release|Any CPU
 		{248946AE-B9BF-4E27-BB8B-B8967C703981}.Release|x86.Build.0 = Release|Any CPU
+		{CA8FFB11-C327-48C1-94BA-24B9D61021FD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{CA8FFB11-C327-48C1-94BA-24B9D61021FD}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{CA8FFB11-C327-48C1-94BA-24B9D61021FD}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{CA8FFB11-C327-48C1-94BA-24B9D61021FD}.Debug|x64.Build.0 = Debug|Any CPU
+		{CA8FFB11-C327-48C1-94BA-24B9D61021FD}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{CA8FFB11-C327-48C1-94BA-24B9D61021FD}.Debug|x86.Build.0 = Debug|Any CPU
+		{CA8FFB11-C327-48C1-94BA-24B9D61021FD}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{CA8FFB11-C327-48C1-94BA-24B9D61021FD}.Release|Any CPU.Build.0 = Release|Any CPU
+		{CA8FFB11-C327-48C1-94BA-24B9D61021FD}.Release|x64.ActiveCfg = Release|Any CPU
+		{CA8FFB11-C327-48C1-94BA-24B9D61021FD}.Release|x64.Build.0 = Release|Any CPU
+		{CA8FFB11-C327-48C1-94BA-24B9D61021FD}.Release|x86.ActiveCfg = Release|Any CPU
+		{CA8FFB11-C327-48C1-94BA-24B9D61021FD}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{248946AE-B9BF-4E27-BB8B-B8967C703981} = {306A63CC-5797-4D63-86A1-94025CF8C98A}
+		{CA8FFB11-C327-48C1-94BA-24B9D61021FD} = {306A63CC-5797-4D63-86A1-94025CF8C98A}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {D00EB11C-F086-49F7-B7EC-21CC98017753}

README.md

@@ -22,6 +22,17 @@ services.AddDistributedPostgreSqlCache(setup =>
 	// This means que every time starts the application the 
 	// creation of table and database functions will be verified.
 })
+```
+3. Then pull from DI like any other service
+
+```c#
+    private readonly IDistributedCache _cache;
+
+    public WeatherForecastController(IDistributedCache cache)
+    {
+        _cache = cache;
+    }
+
 ```
 ## What it does to my database:
 
@@ -36,7 +47,7 @@ Creates a table and six functions, see scripts folder for more details.
 
 ```
 
-## Runing the sample
+## Runing the console sample
 You will need a local postgresql server with this configuration:
 1. Server listening to port 5432 at localhost
 1. The password of your `postgres` account, if not attached already to your user.
@@ -54,6 +65,9 @@ Then you can delete the database with:
 prepare-database.cmd -erase
 ```
 ## Change Log
+1. v3.0
+   1. [BREAKING CHANGE] - Direct instantiation not preferred
+   2. Single thread loop remover
 1. v2.0.x - Update everything to net5.0, more detailed sample project.
 1. v1.0.8 - Update to latest dependencies -