From ad010765d82d59779ddb142642be5524d2257120 Mon Sep 17 00:00:00 2001
From: nojhan <nojhan@gmail.com>
Date: Sat, 31 Mar 2012 14:39:20 +0200
Subject: [PATCH] description in README

---
 README | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README b/README
index a7b60cf..92cfdb9 100644
--- a/README
+++ b/README
@@ -1 +1,10 @@
 Color Up Arbitrary Command Ouput
+
+A regular expression based formatter that color up an arbitrary text output stream.
+Examples :
+   cat colout.py | colout color red bold
+   colout /home/[a-z]+ magenta < /etc/passwd
+   ls -l | colout .\(r.-\){3} yellow standard
+   make 2>&1 | colout [0-9]+ green | colout error
+   make 2>&1 | colout [0-9]+ yellow standard | colout error | colout warning magenta | colout \(note\)\|\(#pragma\\s+\) green standard
+