aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2024-06-27 01:08:20 +0200
committermetamuffin <metamuffin@disroot.org>2024-06-27 01:08:20 +0200
commitfb29b1d5b9e3312affd1b0a997172c6b3008ce17 (patch)
tree1df20017665e8524deba476ad31fae1780167e6d
parent3a3313704ab7589c3fd0f939c4744e74cd4a78fe (diff)
downloadblubcat-fb29b1d5b9e3312affd1b0a997172c6b3008ce17.tar
blubcat-fb29b1d5b9e3312affd1b0a997172c6b3008ce17.tar.bz2
blubcat-fb29b1d5b9e3312affd1b0a997172c6b3008ce17.tar.zst
improved readmeHEADmaster
-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`