]> git.refcnt.org Git - colorize.git/commitdiff
Add Usage example
authorSteven Schubiger <stsc@refcnt.org>
Wed, 9 Mar 2016 16:11:26 +0000 (17:11 +0100)
committerSteven Schubiger <stsc@refcnt.org>
Wed, 9 Mar 2016 16:11:26 +0000 (17:11 +0100)
README

diff --git a/README b/README
index a25ddedcddc7bfb28743dc7f94b836925c3d0b6a..afd40b9209282b0b3c96c0c6c52599f0799c8b32 100644 (file)
--- 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.