small doc update
[small-misc-bash] / README
diff --git a/README b/README
index 3e79fecfcf6e3ba1b81913916dd732cb7053c470..c9bfb471abcbf09ea32ff7bd1d97918bf964b554 100644 (file)
--- a/README
+++ b/README
@@ -1,14 +1,29 @@
-This program's main documentation is not here. It is in near the top of any of
-the bash script file(s) which sit next to this file. If there is an executable
-script in this repo, the documentation is also available by passing --help to
-the script/function.
+Utility bash programs
 
-This program is also part of a collection of programs,
-https://gitlab.com/iankelling/bash-programs-by-ian, which are unrelated except
-a few small things like this file.
+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
 
-For programs with 2 files named like foo and foo-function, they are the same but
-provide the flexibility of calling foo the script, or sourcing foo-function and
-calling foo the function.
+The main documentation is availiable via --help and near the top of the
+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.
 
-Patches, bugs, opinions are welcome via gitlab or email Ian Kelling <ian@iankelling.org>
+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.
+
+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>.
+
+There are no known bugs. Any bugs will be added to the individual
+documentation of each file.