From: Steven Schubiger <stsc@refcnt.org>
Date: Wed, 9 Mar 2016 16:11:26 +0000 (+0100)
Subject: Add Usage example
X-Git-Tag: v0.59~13
X-Git-Url: http://git.refcnt.org/?p=colorize.git;a=commitdiff_plain;h=02ff24b4d080945fa5b5eecd8b57780b0035ecea

Add Usage example
---

diff --git a/README b/README
index a25dded..afd40b9 100644
--- a/README
+++ b/README
@@ -43,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.