X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=README.md;h=20f61e0127860b27f6a99b71b8085366474efd9c;hb=d0444b4b0ee8166d911e6b227218d110eb7eddf1;hp=32ca1bb949856717bb4e5a1e1b69b441d3800738;hpb=9696c012e6b9a6c58904baa397ca0ebf78112316;p=websub-hub diff --git a/README.md b/README.md index 32ca1bb..20f61e0 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,8 @@ 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. ### Quickstart Example @@ -126,6 +128,7 @@ 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/ @@ -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 @@ -145,6 +149,7 @@ 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 - test/ - unit and coverage tests