Add babashka self-updater script

[babashka-scripts.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..f02c678
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Babashka Scripts
+
+Miscellaneous [babashka](https://babashka.org "babashka website") scripts I wrote for my own personal use.
+
+## Requirements
+
+babashka (>= 0.2.9)
+
+## Usage
+
+Clone this repository.
+
+``` sh
+cd ~/dev
+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 PATH=$PATH:$HOME/dev/babashka-scripts
+```
+
+## Organization
+
+`lib.clj` contains functions that the other scripts might use. It must be loaded first.