small doc update

[small-misc-bash] / README

diff --git a/README b/README
index 279bfe33d196aab652b5e7999806054a038540de..c9bfb471abcbf09ea32ff7bd1d97918bf964b554 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,29 @@
+Utility bash programs
+
+attribute-cp       Copy owner & perms from 1 file to others
+dircp              Copy a directory structure
+directory-browser  better cd with forward, backward, and history
+extract-all        Extract many types of files
+gitget             Idempotent git clone/pull
+hostmac            Get a host's mac address
+isdiff             Test if FILE1 and FILE2 have the same contents
+ls-enhanced        ls -lA with enhanced output
+psgrep             grep ps and output in a nice format
+rmln               wrap rm, expanding symlink arguments
+wpm-game           Typing speed game
+
 The main documentation is availiable via --help and near the top of the
-bash script file next to this file.
+script files next to this file. Each file is completely self contained,
+and generally unrelated except they are small so it's convenient to put
+them in the same repo.
+
+Files with -function are meant to be sourced and used as a function. The
+other script file can be stripped of the last line and used as a
+function instead of a script.
 
-The script file can be stripped of the last line and used as a function
-instead of a script.
+Please email me if you have a patches (patch file or git repo are fine),
+bugs, feedback, or republish this somewhere else: Ian Kelling
+<ian@iankelling.org>.
 
-Please email me if you have a patches, bugs, feedback, or republish this
-somewhere else: Ian Kelling <ian@iankelling.org>.
+There are no known bugs. Any bugs will be added to the individual
+documentation of each file.