improve documentation
[small-misc-bash] / README
diff --git a/README b/README
index 8bbec69b987e37ab2163d092e5b0eba9e8e95d9f..171d490c4cb03a46aea74fcbe757f120d556f538 100644 (file)
--- a/README
+++ b/README
@@ -1,17 +1,29 @@
-The main usage documentation is near the top of any bash script files which sit
-next to this file.
+Utility bash programs
 
-Files ending in -function are for sourcing then calling as a function. Files
-without -function are exactly the same except they are for calling as a script.
+acp                attribute-cp. Copy owner & perms from 1 file to others
+dircp              Copy a directory structure
+directory-browser  better cd with forward, backward, and history
+ex                 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
+ll-function        ls -lA with enhanced output
+psg-function       ps grep. Grep output of ps.
+rmln               wrap rm, recursively expanding symlink arguments
+wpm-game           Typing speed game
 
-Patches and bugs are very welcome via gitlab.
+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.
 
-Questions, feedback, etc are very welcome via email to Ian Kelling
-<ian@iankelling.org>. I will add any useful questions, answers, etc. to this
-file. The scope/userbase of this project doesn't justify a mailing list, but if
-it ever did I would start a discourse instance category to act as a mailing list
-and forum.
+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.
 
-This program is also part of a collection of programs,
-https://gitlab.com/iankelling/bash-programs-by-ian, which are unrelated except
-having the same author and being being bash programs.
+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.