diff --git a/README.md b/README.md new file mode 100644 index 0000000..36843fa --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# RethinkDB.DistributedCache + +[![Nuget (with prereleases)][pkg-img]][pkg-url] + +This library provides an ASP.NET Core-capable distributed cache backed by RethinkDB. + +For a quick start, see [the library's README][lib]. + +For a slightly longer read, see [the full library documentation][proj]. + +[pkg-img]: https://img.shields.io/nuget/vpre/RethinkDB.DistributedCache +[pkg-url]: https://www.nuget.org/packages/RethinkDB.DistributedCache/ +[lib]: ./tree/main/src/RethinkDB.DistributedCache/README.md +[proj]: https://bitbadger.solutions/open-source/rethinkdb-distributedcache/ diff --git a/src/RethinkDB.DistributedCache/Cache.fs b/src/RethinkDB.DistributedCache/Cache.fs index cfeb017..a7a3482 100644 --- a/src/RethinkDB.DistributedCache/Cache.fs +++ b/src/RethinkDB.DistributedCache/Cache.fs @@ -103,7 +103,7 @@ module Entry = let get cacheOpts log (key : string) (cancelToken : CancellationToken) = backgroundTask { let table = table cacheOpts let debug = debug cacheOpts log - debug <| fun () -> $"Retriving cache entry {key}" + debug <| fun () -> $"Retrieving cache entry {key}" match! rethink { withTable table get key diff --git a/src/RethinkDB.DistributedCache/README.md b/src/RethinkDB.DistributedCache/README.md new file mode 100644 index 0000000..c9c597a --- /dev/null +++ b/src/RethinkDB.DistributedCache/README.md @@ -0,0 +1,40 @@ +# RethinkDB.DistributedCache + +This package provides an [ASP.NET Core cache implementation][cache] backed by [RethinkDB][]. + +## Quick Start + +### C# + +```csharp +using RethinkDB.DistributedCache; + +IConnection conn = yourRethinkDBConnection; // set up connection first + +// within ASP.NET Core service configuration +builder.Services.AddDistributedRethinkDBCache(opts => opts.Connection = conn); + +// it will be used by other processes, such as sessions +``` + +### F# + +```fsharp +open RethinkDB.DistributedCache + +let conn = yourRethinkDBConnection // set up connection first + +// within ASP.NET Core service configuration +let _ = builder.Services.AddDistributedRethinkDBCache(fun opts -> + opts.Connection <- conn) + +// it will be used by other processes, such as sessions +``` + +## More Information + +More information and details can be found at the [project site][]. + +[cache]: https://docs.microsoft.com/en-us/aspnet/core/performance/caching/distributed +[RethinkDB]: https://www.rethinkdb.com +[project site]: https://bitbadger.solutions/open-source/rethinkdb-distributedcache/ diff --git a/src/RethinkDB.DistributedCache/RethinkDB.DistributedCache.fsproj b/src/RethinkDB.DistributedCache/RethinkDB.DistributedCache.fsproj index ad60837..1b72ae1 100644 --- a/src/RethinkDB.DistributedCache/RethinkDB.DistributedCache.fsproj +++ b/src/RethinkDB.DistributedCache/RethinkDB.DistributedCache.fsproj @@ -2,27 +2,29 @@ net6.0;netstandard2.0 + An IDistributedCache implementation utilizing RethinkDB for storage true - 0.9.0 - danieljsummers - https://github.com/danieljsummers/RethinkDB.DistributedCache + Daniel J. Summers,Bit Badger Solutions + https://github.com/bit-badger/RethinkDB.DistributedCache + git + https://bitbadger.solutions/open-source/rethinkdb-distributedcache/ + logo.png + README.md false - https://github.com/danieljsummers/RethinkDB.DistributedCache - Git MIT License MIT - RethinkDB IDistributedCache ASP.NET Core - An IDistributedCache implementation utilizing RethinkDB for storage - alpha05 - Provider now stores successfully; do not use an earlier version + RethinkDB IDistributedCache aspnetcore + 1.0.0 + rc1 + Release Candidate; repackaged with more stable underlying driver and documentation - - + + @@ -31,6 +33,8 @@ + + diff --git a/src/RethinkDB.DistributedCache/logo.png b/src/RethinkDB.DistributedCache/logo.png new file mode 100644 index 0000000..8dba85b Binary files /dev/null and b/src/RethinkDB.DistributedCache/logo.png differ