initial commit

[squeep-authentication-module] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
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.