git: minor changes

[babashka-scripts.git] / README.md

diff --git a/README.md b/README.md
index 8cbda0831e1edd27e853e754bedc9070dd765329..fb44973ae690978a2a20ce84cdc8b4885381e0fc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -31,3 +31,30 @@ Some tasks can also take arguments.
 ``` sh
 bb ebook-to-audiobook the-great-gatsby.epub
 ```
+
+## Shell aliases
+
+``` sh
+# bash, zsh
+source /path/to/babashka-scripts/bb-aliases.sh
+alias task = bb --config ~/dev/babashka-scripts/bb.edn
+
+# nu
+source /path/to/babashka-scripts/bb-aliases.nu
+alias task = bb --config ~/dev/babashka-scripts/bb.edn
+```
+
+*Example:* To pull all the repositories in a directory, run
+
+``` sh
+task gpa .
+```
+
+There is a utility `bbe` to run tasks in the current working directory in `bb-aliases.sh`.
+
+
+*Example:* To pull all the repositories in a directory, run
+
+``` sh
+bbe gpa
+```