update html template dependency and templates

[websub-hub] / README.md

diff --git a/README.md b/README.md
index 32ca1bb949856717bb4e5a1e1b69b441d3800738..138e4583cbd3c6d247d29d8a934beb1692b1823b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -20,6 +20,8 @@ A user will need to be created in order to view the `/admin` pages; the `bin/aut
 
 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.
@@ -36,6 +38,7 @@ One way of deploying this server is behind nginx, with the pm2 package to manage
   > 'use strict';
   > // Minimum required configuration settings
   > module.exports = {
+  >   encryptionSecret: 'this is a secret passphrase, it is pretty important to be unguessable',
   >   dingus: {
   >     selfBaseUrl: 'https://hub.squeep.com/',
   >   },
@@ -135,6 +138,7 @@ This implementation is built atop an in-house API framework, for Reasons.  It wo
     - schema-version-helper.js - schema migrations aide
     - postgres/
       - index.js - PostgreSQL implementation
+      - listener.js - notify/listen connection to support topic content caching
       - sql/ - statements and schemas
     - sqlite/
       - index.js - SQLite implementation
@@ -147,5 +151,6 @@ This implementation is built atop an in-house API framework, for Reasons.  It wo
   - service.js - defines incoming endpoints, linking the API server framework to the manager methods
   - 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