Add utils and shell aliases

[babashka-scripts.git] / README.md

diff --git a/README.md b/README.md
index f02c678c1394f4d6d4152a2e505de2710c0a95dd..7fa32943b0d794a115e9266b54bc7a8b32a53284 100644 (file)
--- a/README.md
+++ b/README.md
@@ -18,10 +18,23 @@ git clone https://njoseph.me/gitweb/babashka-scripts.git
 Add the following lines to your shell configuration file.
 
 ``` sh
-export BABASHKA_PRELOADS='(load-file (str (System/getProperty "user.home") "/dev/babashka-scripts/lib.clj"))'
+export BABASHKA_PRELOADS='(run! load-file (map #(str (System/getProperty "user.home") "/dev/babashka-scripts/" %) ["lib.clj" "utils.clj"]))'
+export BABASHKA_PRELOADS=$BABASHKA_PRELOADS"  (require '[utils :refer :all])"
 export PATH=$PATH:$HOME/dev/babashka-scripts
 ```
 
+Some useful aliases.
+
+``` sh
+alias gup="bb -e '(git-pull-rebase-branch)'"
+```
+
 ## Organization
 
-`lib.clj` contains functions that the other scripts might use. It must be loaded first.
+`lib.clj` contains functions that the other scripts might use. It must be loaded
+first.
+
+`utils.clj` contains standalone utilities that can be executed directly. These are
+convenient to use through shell aliases.
+
+The remaining Clojure files are executable scripts.