Add table of contents to README

Author: Tamas Pallos

.github/workflows/doctoc.yml

@@ -0,0 +1,21 @@
+name: Doctoc
+
+on:
+  push:
+  pull_request:
+    branches: [main]
+
+jobs:
+  verify-doctoc:
+    name: Verifies whether table of contents has been updated
+    runs-on: ubuntu-20.04
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Run doctoc on README
+        run: npx doctoc README.md
+
+      - name: Verify that doctoc command made no changes, so ToC is up to date
+        run: '[ -z "$(git status --porcelain)" ]'

README.md

@@ -2,6 +2,15 @@
 
 Tools which are commonly used by other JORE4 projects
 
+<!-- regenerate with: "./development.sh toc" -->
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Tools for Docker](#tools-for-docker)
+  - [read-secrets.sh](#read-secretssh)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 ## Tools for Docker
 
 ### read-secrets.sh

development.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+set -eu
+
+function toc {
+  echo "Refreshing Table of Contents"
+
+  npx doctoc README.md
+}
+
+function usage {
+  echo "
+  Usage $0 <command>
+
+  toc
+    Refreshes the Table of Contents in the README.
+
+  help
+    Show this usage information
+  "
+}
+
+case $1 in
+toc)
+  toc
+  ;;
+
+help)
+  usage
+  ;;
+
+*)
+  usage
+  ;;
+esac