readme

Author: Alex Peck

src/BitFaster.Caching.DependencyInjection/BitFaster.Caching.DependencyInjection.csproj

@@ -4,19 +4,19 @@
     <TargetFramework>netstandard2.0</TargetFramework>
 	<Copyright>Copyright © Alex Peck $([System.DateTime]::Now.ToString(yyyy))</Copyright>
 	<RepositoryUrl>https://github.com/bitfaster/BitFaster.Caching.DependencyInjection</RepositoryUrl>
-	  <PackageProjectUrl></PackageProjectUrl>
-	  <Authors>Alex Peck</Authors>
-	  <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-	  <Company />
-	  <Product>BitFaster.Caching</Product>
-	  <Description>High performance, thread-safe in-memory caching primitives for .NET.</Description>
-	  <PackageTags>Cache;LRU;LFU;Performance;In-Memory;Thread-Safe;Concurrent</PackageTags>
-	  <PackageId>BitFaster.Caching.DependencyInjection</PackageId>
-	  <AssemblyName>BitFaster.Caching.DependencyInjection</AssemblyName>
-	  <RootNamespace>BitFaster.Caching.DependencyInjection</RootNamespace>
-	  <Version>1.0.0</Version>
-	  <AssemblyVersion>1.0.0.0</AssemblyVersion>
-	  <FileVersion>1.0.0.0</FileVersion>
+	<PackageProjectUrl></PackageProjectUrl>
+	<Authors>Alex Peck</Authors>
+	<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+	<Company />
+	<Product>BitFaster.Caching</Product>
+	<Description>BitFaster.Caching extensions for Microsoft.Extensions.DependencyInjection.</Description>
+	<PackageTags>DependencyInjection</PackageTags>
+	<PackageId>BitFaster.Caching.DependencyInjection</PackageId>
+	<AssemblyName>BitFaster.Caching.DependencyInjection</AssemblyName>
+	<RootNamespace>BitFaster.Caching.DependencyInjection</RootNamespace>
+	<Version>1.0.0</Version>
+	<AssemblyVersion>1.0.0.0</AssemblyVersion>
+	<FileVersion>1.0.0.0</FileVersion>
 	<IncludeSource>True</IncludeSource>
 	<IncludeSymbols>True</IncludeSymbols>
 	<EmbedUntrackedSources>true</EmbedUntrackedSources>

src/BitFaster.Caching.DependencyInjection/README.md

@@ -1 +1,46 @@
-Extension methods for setting up caches using Microsoft.Extensions.DependencyInjection.
+Extension methods for setting up caches using Microsoft.Extensions.DependencyInjection.
+
+# ConcurrentLru
+
+To use with an `IServiceCollection` instance at startup:
+
+```cs
+services.AddLru<int, int>(builder =>
+    builder
+        .WithCapacity(666)
+        .Build());
+```
+
+The builder delegate can be used to configure the cache, see the [wiki](https://github.com/bitfaster/BitFaster.Caching/wiki/ConcurrentLru-Quickstart#builder-api) for details.
+
+There is an extension method for each [cache interface](https://github.com/bitfaster/BitFaster.Caching/wiki/Caches):
+
+| Extension | Result | 
+|-----------|--------|
+| AddLru | Registers `ConcurrentLru<int, int>` as a singleton `ICache<int, int>` |
+| AddAsyncLru | Registers `ConcurrentLru<int, int>` as a singleton `IAsyncCache<int, int>` |
+| AddScopedLru | Registers `ConcurrentLru<int, Disposable>` as a singleton `IScopedCache<int, Disposable>` |
+| AddScopedAsyncLru | Registers `ConcurrentLru<int, Disposable>` as a singleton `IScopedAsyncCache<int, Disposable>` |
+
+
+# ConcurrentLfu
+
+To use with an `IServiceCollection` instance at startup:
+
+```cs
+services.AddLfu<int, int>(builder =>
+    builder
+        .WithCapacity(666)
+        .Build());
+```
+
+The builder delegate can be used to configure the cache, see the [wiki](https://github.com/bitfaster/BitFaster.Caching/wiki/ConcurrentLfu-Quickstart#builder-api) for details.
+
+There is an extension method for each [cache interface](https://github.com/bitfaster/BitFaster.Caching/wiki/Caches):
+
+| Extension | Result | 
+|-----------|--------|
+| AddLfu | Registers `ConcurrentLfu<int, int>` as a singleton `ICache<int, int>` |
+| AddAsyncLfu | Registers `ConcurrentLfu<int, int>` as a singleton `IAsyncCache<int, int>` |
+| AddScopedLfu | Registers `ConcurrentLfu<int, Disposable>` as a singleton `IScopedCache<int, Disposable>` |
+| AddScopedAsyncLfu | Registers `ConcurrentLfu<int, Disposable>` as a singleton `IScopedAsyncCache<int, Disposable>` |