Add documentation for gnu-utils

plugins/gnu-utils/README.md

@@ -0,0 +1,31 @@
+gnu-utils
+=========
+
+Provides for the interactive use of [GNU Core Utilities][1] on non-GNU systems.
+
+Installing the GNU Core Utilities on non-GNU systems in `$PATH` without
+a prefix, i.e. `ls` instead of `gls`, is not recommended since scripts that
+target other core utilities will be broken.
+
+However, for interactive use, prefixed commands can be hashed to their
+non-prefixed counterparts.
+
+Settings
+--------
+
+### Prefix
+
+To use a different prefix, add the following to *zshrc*, and replace 'g' with
+the desired prefix:
+
+    zstyle ':omz:plugin:gnu-utils' prefix 'g'
+
+Authors
+-------
+
+*The authors of this plugin should be contacted via the GitHub issue tracker.*
+
+ - [Sorin Ionescu](/sorin-ionescu)
+
+[1]: http://www.gnu.org/software/coreutils/
+

plugins/gnu-utils/init.zsh

@@ -4,13 +4,6 @@
 # Authors:
 #   Sorin Ionescu <[email protected]>
 #
-# Usage:
-#
-#   To use a different prefix, add the following to zshrc,
-#   and replace 'g' with the desired prefix:
-#
-#     zstyle ':omz:plugin:gnu-utils' prefix 'g'
-#
 
 # Get the prefix or use the default.
 zstyle -s ':omz:plugin:gnu-utils' prefix '_gnu_utils_prefix' ||