update html template dependency and templates
[websub-hub] / README.md
index 31e921e734302a5bc3a2d5f00600c42e7a672e49..138e4583cbd3c6d247d29d8a934beb1692b1823b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -18,10 +18,10 @@ Database table initialization and schema version migrations are automated.  Conf
 
 A user will need to be created in order to view the `/admin` pages; the `bin/authAddUser.js` script will do this.
 
-An IndieAuth profile may be used to view any topics associated with that profile.
-
 The bundled logger spews JSON to stdout.
 
+An IndieAuth profile may be used to view any topics associated with that profile.
+![IndieAuth view of topics](./documentation/media/topics-indieauth.png)
 ### Quickstart Example
 
 One way of deploying this server is behind nginx, with the pm2 package to manage the server process, and a local postgres database.  Some details on this are presented here as a rough guide to any parts of this stack which may be unfamiliar.
@@ -129,7 +129,6 @@ This implementation is built atop an in-house API framework, for Reasons.  It wo
   - *.js - environment specific values, edit these as needed
 - server.js - launches the application server
 - src/
-  - authenticator.js - interact with credentials and validation mechanisms
   - common.js - utility functions
   - communication.js - outgoing requests and associated logic
   - db/
@@ -150,8 +149,8 @@ This implementation is built atop an in-house API framework, for Reasons.  It wo
   - logger.js - a very simple logging class
   - manager.js - process incoming requests
   - service.js - defines incoming endpoints, linking the API server framework to the manager methods
-  - session-manager.js - process login/logout requests
   - template/ - HTML content
   - worker.js - maintains a pool of tasks in progress, for sending out updates, performing verifications, et cetera
+- static/ - static assets
 - test/ - unit and coverage tests
 - test-e2e/ - support for whole-service testing