documentation

z.sh

@@ -1,6 +1,19 @@
 #!/bin/bash
 
-# pure shell version of 'new j'
+# maintains a jump-list of the directories you actually use
+#
+# INSTALL:
+#   * put something like this in your .bashrc:
+#     . /path/to/z.sh
+#   * cd around for a while to build up the db
+#   * PROFIT!!
+#
+# USE:
+#   * z foo     # goes to most frecent dir matching foo
+#   * z foo bar # goes to most frecent dir matching foo and bar
+#   * z -r rank # goes to highest ranked dir matching foo
+#   * z -t rank # goes to most recently accessed dir matching foo
+#   * z -l foo  # list all dirs matching foo (by frecency)
 
 z() {
  local datafile=$HOME/.z