From 12b1029989cf05e40046b6f163d9b4bf6ce931a5 Mon Sep 17 00:00:00 2001
From: "Alex A. Naanou" <alex.nanou@gmail.com>
Date: Mon, 21 Oct 2024 16:15:22 +0300
Subject: [PATCH] docs...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
---
 .github/workflows/toc.yml |  8 ++++++++
 README.md                 | 20 +++++++++++---------
 2 files changed, 19 insertions(+), 9 deletions(-)
 create mode 100644 .github/workflows/toc.yml

diff --git a/.github/workflows/toc.yml b/.github/workflows/toc.yml
new file mode 100644
index 0000000..8481c7e
--- /dev/null
+++ b/.github/workflows/toc.yml
@@ -0,0 +1,8 @@
+on: push
+name: TOC Generator
+jobs:
+  generateTOC:
+    name: TOC Generator
+    runs-on: ubuntu-latest
+    steps:
+      - uses: technote-space/toc-generator@v4
diff --git a/README.md b/README.md
index 48f17ac..0579292 100644
--- a/README.md
+++ b/README.md
@@ -3,18 +3,20 @@
 A set of scripts for automating setup and tasks in proxmox.
 
 ## TODO
-- revise defaults
+- CT updates
+- backup/restore
+- mail
+- which is better?
+  - Makefile (a-la ./wireguard/templates/root/Makefile)
+  - shell (a-la ./shadow/templates/root/update-shadowsocks.sh)
 - separate templates/assets into distribution and user directories
   ...this is needed to allow the user to change the configs without the 
   fear of them being overwritten by git (similar to how config is handlerd)
-- might be a good idea to export a specific ct script that can be used 
-  for updates for that ct
-- which is better?
-  - Makefile (a-la wireguard)
-  - shell (a-la shadow)
-- ct updates
-- backup/restore
-- mail
+
+
+<!-- START doctoc -->
+<!-- END doctoc -->
+
 
 
 ## Motivation