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

---
 README.md | 6 ++++++
 README.sh | 8 +++++---
 2 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 61f914c..2aeb0b8 100644
--- a/README.md
+++ b/README.md
@@ -9,3 +9,9 @@
 
 # Packages
 
+| package | description |
+|-|-|
+| [fzy](fzy) | lightweight + fast fuzzyfinder alternative |
+| [vim](vim) | Most popular clone of the VI editor |
+
+> developers: run `echo "$(./README.sh)" > README.md` to regenerate this README.md after adding a pkg
diff --git a/README.sh b/README.sh
index 59a8f84..2106354 100755
--- a/README.sh
+++ b/README.sh
@@ -1,9 +1,11 @@
-# printf README.md until '# Component List'
+#!/bin/sh
+
+# print 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) |"
+  echo "| [$pkg]($pkg) | $(awk 'NR == 3 {print $0}' $pkg/README.md) |"
 done
-echo -e "\n> developers: run `./README.sh` to regenerate this README.md after adding a pkg"
+echo -e '\n> developers: run `echo "$(./README.sh)" > README.md` to regenerate this README.md after adding a pkg'