add README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..3e79fec
--- /dev/null
+++ b/README
@@ -0,0 +1,14 @@
+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.
+
+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.
+
+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.
+
+Patches, bugs, opinions are welcome via gitlab or email Ian Kelling <ian@iankelling.org>