diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index 57d134b..18825b5 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -25,6 +25,8 @@ jobs:
run: dotnet restore
- name: Build
run: dotnet build --no-restore
+ - name: Validate package
+ run: dotnet pack src/PostgreSignalR.csproj --no-build -c Debug
- name: Test
run: dotnet test --project tests/PostgreSignalR.IntegrationTests/PostgreSignalR.IntegrationTests.csproj -f ${{ matrix.tfm }} --no-build --output Detailed --hangdump --hangdump-timeout 2m --hangdump-type Mini --stop-on-fail on
timeout-minutes: 10
diff --git a/README.md b/README.md
index 30788b9..6e001e0 100644
--- a/README.md
+++ b/README.md
@@ -4,13 +4,13 @@
# PostgreSignalR
-
+
A **non-opinionated** and easily **configurable** PostgreSQL backplane for SignalR
-_Currently in Release Candidate stage and happy for your feedback!_
+_Production-ready and happy for your feedback!_
@@ -230,24 +230,20 @@ To stress again though - these results are with one particular configuration on
# Roadmap
-This library is brand-new, so while it should support all SignalR features it hasn't been thoroughly tested and vetted for production use. The immediate next steps are aimed at making this production-ready:
+PostgreSignalR is ready for production use: it supports all SignalR features, is covered by an integration test suite that runs against every supported .NET version, and is already running in production systems.
-1. Automated tests to ensure the functionality of the library
-2. Performance tests and benchmarks to optimize the code and find at-scale bugs
-3. Writing one or several example applications utilizing all of the SignalR features
-4. Adding additional configuration options to allow more flexibility in error handling
-5. Observe in production or production-like scenarios
+## Versioning
-Right now the library has been released on Nuget in a release candidate version, which I mean to be an indication that this is a stable product and the API is unlikely to change. Testing has been successful, and the only blocker for the production release is finishing a suite of benchmarks to be able to provide reliable documentation about the functionality of the library on the edge.
+PostgreSignalR follows [Semantic Versioning](https://semver.org/). The public API consists of the dependency injection extensions, the options classes (`PostgresBackplaneOptions` and `PayloadTableOptions`), and the payload strategy types (`IPayloadStrategy`, `EventPayloadStrategy`, and `TablePayloadStrategy`). Breaking changes to any of these will only be made in a new major version.
-* Alpha: The viability of the product is being tested, there are known major bugs
-* Beta: Testing has given confidence that this is a viable product and major bugs and performance issues have been resolved
-* RC: Further changes to the interface are unlikely and testing has indicated that the product is stable
-* Prod: The library is ready for use in production systems
+PostgreSignalR targets every version of .NET that is [currently supported by Microsoft](https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core). Support for new .NET versions is added in minor versions, and support for a .NET version is dropped in a new major version once Microsoft stops supporting it.
-Alpha and beta versions will progress through `0.x.0-alpha` and `0.x.0-beta`, while the release candidates will start at `1.0.0-rc-x`. `1.0.0` will be the first production release.
+## Next Steps
-I'm liking at a relatively quick timeline through RC and prod, though I do only get so many hours to work on this. Contributions are welcome!
+1. Finish the benchmark suite to provide reliable documentation about the performance of the library at the edge
+2. Add configuration options to allow more flexibility in error handling
+
+Contributions are welcome!
# Developing and Testing
diff --git a/README_NUGET.md b/README_NUGET.md
index 203e83f..422ea2b 100644
--- a/README_NUGET.md
+++ b/README_NUGET.md
@@ -77,20 +77,20 @@ For more advanced use cases, PostgreSignalR allows you to create a custom payloa
# Roadmap
-This library is brand-new, so while it should support all SignalR features it hasn't been thoroughly tested and vetted for production use. The immediate next steps are aimed at making this production-ready:
+PostgreSignalR is ready for production use: it supports all SignalR features, is covered by an integration test suite that runs against every supported .NET version, and is already running in production systems.
-1. Automated tests to ensure the functionality of the library
-2. Performance tests and benchmarks to optimize the code and find at-scale bugs
-3. Writing one or several example applications utilizing all of the SignalR features
-4. Adding additional configuration options to allow more flexibility in error handling
+## Versioning
-Right now the library has been released on Nuget in an alpha version, denoting that it is relatively untested _and_ the API may be subject to change. In this case, the "API" consists entirely of the dependency injection extensions and the `PostgresOptions` class. The beta, rc, and prod milestones will denote:
+PostgreSignalR follows [Semantic Versioning](https://semver.org/). The public API consists of the dependency injection extensions, the options classes (`PostgresBackplaneOptions` and `PayloadTableOptions`), and the payload strategy types (`IPayloadStrategy`, `EventPayloadStrategy`, and `TablePayloadStrategy`). Breaking changes to any of these will only be made in a new major version.
-* Beta: Testing has given confidence that this is a viable product and major bugs and performance issues have been resolved
-* RC: Further changes to the interface are unlikely and testing has indicated that the product is stable
-* Prod: The library is ready for use in production systems
+PostgreSignalR targets every version of .NET that is [currently supported by Microsoft](https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core). Support for new .NET versions is added in minor versions, and support for a .NET version is dropped in a new major version once Microsoft stops supporting it.
-Alpha and beta versions will progress through `0.x.0-alpha` and `0.x.0-beta`, while the release candidates will start at `1.0.0-rc.x`. `1.0.0` will be the first production release.
+## Next Steps
+
+1. Finish the benchmark suite to provide reliable documentation about the performance of the library at the edge
+2. Add configuration options to allow more flexibility in error handling
+
+Contributions are welcome!
# Developing and Testing
diff --git a/src/CompatibilitySuppressions.xml b/src/CompatibilitySuppressions.xml
new file mode 100644
index 0000000..fff6700
--- /dev/null
+++ b/src/CompatibilitySuppressions.xml
@@ -0,0 +1,12 @@
+
+
+
+
+ PKV006
+ net8.0
+
+
+ PKV006
+ net9.0
+
+
\ No newline at end of file
diff --git a/src/PostgreSignalR.csproj b/src/PostgreSignalR.csproj
index 54feca6..08d6afc 100644
--- a/src/PostgreSignalR.csproj
+++ b/src/PostgreSignalR.csproj
@@ -12,6 +12,7 @@
true
true
true
+ 0.5.0-rc-1
SignalR;Postgres;PostgreSQL;Npgsql;ASP;ASPNET;ASPNETCORE
https://github.com/IanWold/PostgreSignalR