Update deps + Add docs = RC1

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/

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<CacheEntry> {
             withTable table
             get key

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/

src/RethinkDB.DistributedCache/RethinkDB.DistributedCache.fsproj

@@ -2,27 +2,29 @@
 
     <PropertyGroup>
         <TargetFrameworks>net6.0;netstandard2.0</TargetFrameworks>
+        <Description>An IDistributedCache implementation utilizing RethinkDB for storage</Description>
         <GenerateDocumentationFile>true</GenerateDocumentationFile>
-        <VersionPrefix>0.9.0</VersionPrefix>
+        <Authors>Daniel J. Summers,Bit Badger Solutions</Authors>
-        <Authors>danieljsummers</Authors>
+        <RepositoryUrl>https://github.com/bit-badger/RethinkDB.DistributedCache</RepositoryUrl>
-        <PackageProjectUrl>https://github.com/danieljsummers/RethinkDB.DistributedCache</PackageProjectUrl>
+        <RepositoryType>git</RepositoryType>
+        <PackageProjectUrl>https://bitbadger.solutions/open-source/rethinkdb-distributedcache/</PackageProjectUrl>
+        <PackageIcon>logo.png</PackageIcon>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
         <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
-        <RepositoryUrl>https://github.com/danieljsummers/RethinkDB.DistributedCache</RepositoryUrl>
-        <RepositoryType>Git</RepositoryType>
         <Copyright>MIT License</Copyright>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
-        <PackageTags>RethinkDB IDistributedCache ASP.NET Core</PackageTags>
+        <PackageTags>RethinkDB IDistributedCache aspnetcore</PackageTags>
-        <Description>An IDistributedCache implementation utilizing RethinkDB for storage</Description>
+        <VersionPrefix>1.0.0</VersionPrefix>
-        <VersionSuffix>alpha05</VersionSuffix>
+        <VersionSuffix>rc1</VersionSuffix>
-        <PackageReleaseNotes>Provider now stores successfully; do not use an earlier version</PackageReleaseNotes>
+        <PackageReleaseNotes>Release Candidate; repackaged with more stable underlying driver and documentation</PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>
         <PackageReference Include="Microsoft.Extensions.Caching.Abstractions" Version="6.0.0" />
         <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="*" />
         <PackageReference Include="Microsoft.Extensions.Options" Version="6.0.0" />
-        <PackageReference Include="RethinkDb.Driver.FSharp" Version="0.8.0-alpha-0007" />
+        <PackageReference Include="RethinkDb.Driver.FSharp" Version="0.9.0-beta-03" />
-        <PackageReference Update="FSharp.Core" Version="6.0.3" />
+        <PackageReference Update="FSharp.Core" Version="6.0.4" />
     </ItemGroup>
 
     <ItemGroup>
@@ -31,6 +33,8 @@
         <Compile Include="Cache.fs" />
         <Compile Include="DistributedRethinkDBCache.fs" />
         <Compile Include="IServiceCollectionExtensions.fs" />
+        <None Include="README.md" Pack="true" PackagePath="\" />
+        <None Include="logo.png" Pack="true" PackagePath="\" />
     </ItemGroup>
 
 </Project>