add ERD to readme
authorJustin Wind <justin.wind+git@gmail.com>
Mon, 14 Mar 2022 01:43:10 +0000 (18:43 -0700)
committerJustin Wind <justin.wind+git@gmail.com>
Mon, 14 Mar 2022 01:43:10 +0000 (18:43 -0700)
README.md

index 138e4583cbd3c6d247d29d8a934beb1692b1823b..5af15f0668c5fca11c22b55e41276860633435ea 100644 (file)
--- 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