aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/README.md b/README.md
index 893c168..ca6955b 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,13 @@
# blubcat
-Thing
+A small Rust program that is like `cat` but colorizes the output according to
+some pattern. Patterns can be composed in a modular manner.
+
+## Usage
+
+See `blubcat --help`. Or try an example:
+
+- `blubcat -S red,green,blue -G red,green,blue -T --multiply -s 0.1 /etc/passwd`
+- `blubcat -S red,green,blue -G red,green,blue -T --multiply -s 0.1 /etc/passwd`
+- `blubcat -R -R -T --mix 0.5 -s 0.1 /etc/passwd`
+- `fortune | cowsay | blubcat -R -t 0.8 0 -s 0.01 -r -0.125`