README: Add documentation of $gsu_options.

[gsu.git] / README

diff --git a/README b/README
index 8dd6daf1b8fd6ecd55d4d5ae8d3d123f57da41dd..c0bfe18914b2323cdbabf9fa380e27a4760eb5ff 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,8 @@
+=====
 <<
 <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,
@@ -692,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.