good working version of acp
[small-misc-bash] / README
diff --git a/README b/README
index 279bfe33d196aab652b5e7999806054a038540de..c2ec389e8c6d2ee1d9dcc0245297c22e08e23feb 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,15 @@
 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.
 
-The script file can be stripped of the last line and used as a function
-instead of a script.
+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, bugs, feedback, or republish this
-somewhere else: Ian Kelling <ian@iankelling.org>.
+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.
\ No newline at end of file