From c3a44ac4f767ebbb1c56ef73501bafcf356c49d2 Mon Sep 17 00:00:00 2001
From: simon <simobilleter@gmail.com>
Date: Fri, 20 May 2022 11:51:14 +0700
Subject: [PATCH] project description for publishing

---
 README.md | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 21950f8..0d625cb 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,17 @@
 # Tube Archivist Server
 All code for www.tubearchivist.com.
 
-# Important
-Webhook API endpoints aren't verified proberly. Don't publish until that's done.
+## Tubearchivist
+Flask API to render the html website. Build with Docker. API endpoints to:
+
+### Listen for GitHub hooks to
+- Create tasks for unstable testing images
+- Create tasks for new releases
+- Update Roadmap in Discord
+
+### Listen for DockerHub hooks to
+- Send notifications for new unstable builds to Discord
+- Send nitifications for new release builds to Discord
+
+## Builder
+Standalone python script subscribed to Redis waiting for build commands.