From 2c3272a2d9a57821fdaf97f7e5490e7d772c033c Mon Sep 17 00:00:00 2001
From: Marco Thomas <mail+github@marcothms.de>
Date: Tue, 28 Nov 2023 11:32:03 +0100
Subject: [PATCH] chore(readme): update stow.sh

---
 README.md | 13 ++++++++++++-
 stow.sh   |  4 +++-
 2 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 0ac1dc8..daf9b95 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,12 @@
-# my dots
+# my dotfiles
+
+Everything is managed via `stow(1)`.
+
+```bash
+$ ./stow.sh 
+Unknown option, exiting.
+Use ./stow.sh --stow <folder_name> to deploy configuration
+Use ./stow.sh --unstow <folder_name> to remove configuration
+```
+
+`helix(1)` should be built from [source](https://docs.helix-editor.com/install.html), remember to link the `runtime/`.
diff --git a/stow.sh b/stow.sh
index 850cd71..53cd709 100755
--- a/stow.sh
+++ b/stow.sh
@@ -16,7 +16,9 @@ case $i in
     stow -D -v -d files -t $HOME $2
     ;;
     *)
-    echo "Unknown option (neither -s, not -u), exiting."
+    echo "Unknown option, exiting."
+    echo "Use $0 --stow <folder_name> to deploy configuration"
+    echo "Use $0 --unstow <folder_name> to remove configuration"
     exit -1
     ;;
 esac