X-Git-Url: https://git.squeep.com/?a=blobdiff_plain;f=README.md;fp=README.md;h=3004f71e272272300f5530f78cdf3a4067ddb0f1;hb=dd173e6b450cbba8100883514610c9fde83d050a;hp=0000000000000000000000000000000000000000;hpb=7442dd9aef45fe74dc7abe4d111c734068ef2f7d;p=squeep-authentication-module

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3004f71
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# @squeep/authentication-module
+
+Common session-based authentication routines, page templates, and management handlers.
+
+Specific to Squeep Framework Applications, this module has strong opinions and makes many assumptions.
+
+Supports IndieAuth profile identifiers, and database-backed user identifiers.
+
+## API
+
+### Authenticator
+
+Class which fetches and validates identifiers and their credentials from database.
+
+There are some methods for dealing with Basic auth in here as well, but they are not used by sessions.
+
+### SessionManager
+
+Class providing service handler functions for rendering and processing session login and logout pages.