From dbdb34d8c54312fcae2d8222550efdb4a52fe4cc Mon Sep 17 00:00:00 2001
From: Leon van Kammen <leonvankammen@gmail.com>
Date: Thu, 27 Mar 2025 11:03:56 +0100
Subject: [PATCH] main: update documentation

---
 README.md | 11 +++++++++++
 README.sh |  9 +++++++++
 2 files changed, 20 insertions(+)
 create mode 100644 README.md
 create mode 100755 README.sh

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..61f914c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+<img src='https://xrsh.isvery.ninja/xrsh.svg' width="25%"/>
+
+[XRSH](https://xrsh.isvery.ninja) supports (zip) packages:
+
+* to act as filesystem overlay
+* to act as application container (via autoenv's `.env`-file)
+
+> Read more [about XRSH packages](https://xrsh.isvery.ninja/#XRSH%20zip%20packages)
+
+# Packages
+
diff --git a/README.sh b/README.sh
new file mode 100755
index 0000000..59a8f84
--- /dev/null
+++ b/README.sh
@@ -0,0 +1,9 @@
+# printf README.md until '# Component List'
+grep -B9999 '# Packages' README.md
+echo ''
+echo '| package | description |'
+echo '|-|-|'
+find * -maxdepth 0 -type d | while read pkg; do 
+  echo "| [$pkg]($pkg) | $(awk 'NR == 3' $pkg/README.md) |"
+done
+echo -e "\n> developers: run `./README.sh` to regenerate this README.md after adding a pkg"