colorize 0.59

[colorize.git] / README

diff --git a/README b/README
index 159291eb96b63f2607797b42b90265e88310a7be..afd40b9209282b0b3c96c0c6c52599f0799c8b32 100644 (file)
--- a/README
+++ b/README
@@ -32,6 +32,8 @@ currently no make targets to install it as such.
 
 Finally, remove it through `make clean'.
 
+Debugging instructions
+----------------------
 For the sake of completeness, colorize can be also built with
 debugging output by issuing `make FLAGS=-DDEBUG'.  The intention
 is to provide some memory allocation diagnostics (and might be
@@ -41,6 +43,18 @@ Documentation
 -------------
 See man page source file: colorize.1.
 
+Usage example
+-------------
+In ~/.bashrc:
+
+| ls_color() {
+|     ls "$@" | colorize green -
+| }
+| alias ls=ls_color
+
+This excerpt defines an alias which will set the color being
+printed for literal ls invocations to green.
+
 Afterword
 ---------
 Let me know, if you have ideas, bug reports, patches, etc.