aboutsummaryrefslogtreecommitdiff
path: root/libs/VNLib.Plugins.Sessions.OAuth/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'libs/VNLib.Plugins.Sessions.OAuth/README.md')
-rw-r--r--libs/VNLib.Plugins.Sessions.OAuth/README.md18
1 files changed, 12 insertions, 6 deletions
diff --git a/libs/VNLib.Plugins.Sessions.OAuth/README.md b/libs/VNLib.Plugins.Sessions.OAuth/README.md
index 03d27d9..310225f 100644
--- a/libs/VNLib.Plugins.Sessions.OAuth/README.md
+++ b/libs/VNLib.Plugins.Sessions.OAuth/README.md
@@ -1,13 +1,19 @@
# VNLib.Plugins.Sessions.OAuth
*Provides OAuth2 sessions and required endpoints for authentication via user applications from the VNLib.Plugins.Essentials.Oauth library*
-#### Builds
-Debug build w/ symbols & xml docs, release builds, NuGet packages, and individually packaged source code are available on my [website](https://www.vaughnnugent.com/resources/software). All tar-gzip (.tgz) files will have an associated .sha384 appended checksum of the desired download file.
+This library may be loaded as a standard VNLib.Plugins.Essentials framework plugin (standalone mode) or loaded by the SessionProvider plugin (integrated mode) for multiple runtime session support.
-## Notes
-When dynamically loading this session provider as an asset in the SessionProvider plugin, make sure to order this assembly ahead of other web-based providers if loading multiple providers. OAuth2 sessions are only valid if the connection contains a Bearer token (valid or not it "pre-accepted""), otherwise no session will be attached.
+**This library requires 3rd-party dependencies**
-This plugin may be loaded as a standalone authentication server, by loading it directly as an IPlugin. Sessions are created in the backing stores when a token is generated, and therefore accessable via shared backing stores.
+## Builds
+Debug build w/ symbols & xml docs, release builds, NuGet packages, and individually packaged source code are available on my website (link below).
+
+## Docs and Guides
+Documentation, specifications, and setup guides are available on my website.
+
+[Docs and Articles](https://www.vaughnnugent.com/resources/software/articles?tags=docs,_vnlib.plugins.sessions.oauth)
+[Builds and Source](https://www.vaughnnugent.com/resources/software/modules/VNLib.Plugins.Sessions)
+[Nuget Feeds](https://www.vaughnnugent.com/resources/software/modules)
## License
-Source files in for this project are licensed to you under the GNU Affero General Public License (or any later version). See the LICENSE files for more information. \ No newline at end of file
+Source files in for this project are licensed to you under the GNU Affero General Public License (or any later version). See the LICENSE file for more information.