1.4.0

[squeep-authentication-module] / README.md

diff --git a/README.md b/README.md
index 13d210d54bf24a6e3f6d28af8c0b5098e5208922..6b4400ea56b2285729fd59e3c6fcf307d71a89d4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -34,3 +34,24 @@ Class providing service handler functions for rendering and processing session l
   for local users, or redirecting to IndieAuth server and persisting transient state
   in session cookie.
 - `getAdminIA` interprets the returning redirect from the IndieAuth server.
+- `getAdminSettings` renders the HTML account settings form
+- `postAdminSettings` ingests and acts on account updates
+
+### Helpers
+
+- `sessionNavLinks` call from app templates to populate navLinks for account settings and logout
+
+### Other Notes
+
+For the moment, this imposes a web structure of /admin/* for authentication management paths.
+
+The logger used should be able to mask these context fields:
+
+- `ctx.parsedBody.credential`
+- `ctx.parsedBody.credential-old`
+- `ctx.parsedBody.credential-new`
+- `ctx.parsedBody.credential-new-2`
+- `ctx.otpKey`
+- `ctx.otpConfirmBox`
+- `ctx.otpConfirmKey`
+- `ctx.otpState`