Add utility to run tasks in the current directory

[babashka-scripts.git] / README.md

diff --git a/README.md b/README.md
index 6d2730165bc099b94c8de16c1b58d0c4d1625f9f..6abd22a08ba1dbb8a11483453df3288bc0e7e3b2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -16,8 +16,31 @@ git clone https://njoseph.me/gitweb/babashka-scripts.git
 
 The list of available commands can be found by running `bb tasks` in the directory where the file `bb.edn` is present.
 
+``` sh
+The following tasks are available:
+
+gup                Do a git pull and rebase branch with master in a given directory.
+gpa                Runs `git pull` on all the git repositories in a given directory.
+ebook-to-audiobook A utility to listen to your ebooks using TTS programs. Only tested on macOS with epub files.
+install-deb        Install a Debian package given a direct URL to the .deb file.
+install-deb-gh     Install a Debian package given a GitHub URL.
+```
+
 Some tasks can also take arguments.
 
 ``` sh
 bb ebook-to-audiobook the-great-gatsby.epub
 ```
+
+There are a utility file that makes running the tasks easier. Load it up first.  
+You can also add the following line with the absolute path to the file in your "~/.profile" file.
+
+``` sh
+source bb-aliases.sh
+```
+
+*Example:* To pull all the repositories in a directory, run
+
+``` sh
+bbe gpa
+```