X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=README.md;h=33c86749cca1ae140d0e3670cd8305a4a20e8400;hb=8f63eeebd08491cdc82e12f178dc500f6d19d65c;hp=138e4583cbd3c6d247d29d8a934beb1692b1823b;hpb=33897b863a84ff7d248888f83dc100a96cd9bc49;p=websub-hub diff --git a/README.md b/README.md index 138e458..33c8674 100644 --- a/README.md +++ b/README.md @@ -114,6 +114,8 @@ The Hub keeps track of three primary entities: Any tasks in progress (notably: fetching new topic content, distributing that content to subscribers, or confirming pending verifications) are doled out and managed by a cooperative advisory locking mechanism. The task queue is wrangled in the database within the `*_in_progress` tables. +![Entity relationship diagram for Postgres engine](./documentation/media/postgres-er.svg) + A Hub node will periodically check for more tasks to perform, executing them up to a set concurrency limit. ### Quirks @@ -146,7 +148,7 @@ This implementation is built atop an in-house API framework, for Reasons. It wo - enum.js - invariants - errors.js - local Error types - link-helper.js - processes Link headers - - logger.js - a very simple logging class + - logger/ - adds service-specific data filters to our logging module - manager.js - process incoming requests - service.js - defines incoming endpoints, linking the API server framework to the manager methods - template/ - HTML content