README: Add documentation of $gsu_options.

[gsu.git] / README

diff --git a/README b/README
index 51a8ba6294bff1579614fd11694e87ef05c85655..c0bfe18914b2323cdbabf9fa380e27a4760eb5ff 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,8 @@
-The global subcommand utility
-=============================
+=====
+<<
+<img src='gsu.png' alt="gsu logo"><h2>The global subcommand utility</h2>
+>>
+=====
 gsu is a small library of bash functions intended to ease the task of
 writing and documenting large shell scripts with multiple subcommands,
 each providing different functionality. gsu is known to work on Linux,
@@ -26,7 +29,7 @@ All gsu modules are contained in a git repository. Get a copy with
 
        git clone git://git.tuebingen.mpg.de/gsu.git
 
-There is also a http://ilm.eb.local/gitweb/?p=gsu;a=summary (gitweb) page.
+There is also a http://git.tuebingen.mpg.de/gsu.git (gitweb) page.
 
 Installation
 ~~~~~~~~~~~~
@@ -690,7 +693,7 @@ List of public variables
   - *$gsu_config_file*. The name of the config file of the application.
   Defaults to `~/.${gsu_name}.rc'.
 
-  - *$gsu_options*.
+  - *$gsu_options*. Array of config options, used by the config module.
 
   - *$gsu_config_var_prefix*. Used by the config module to set up
   the variables defined in $gsu_options.