README

README.md

@@ -4,18 +4,31 @@
 [![Crates.io](https://img.shields.io/crates/v/grits.svg)](https://crates.io/crates/grits)
 [![Crates.io](https://img.shields.io/crates/d/grits)](https://crates.io/crates/grits)
 
-`grits` is a minimal, simple, and easy-to-use line text-formatter that applies regular expressions with named captures to input lines
-and transforms them using a template string. It allows for efficient parsing, extracting, and formatting of text,
-including support for colorization and other attributes you'd get using ANSI escape sequences.
+A simple line-text formatter that makes it simple to parse, filter, and format live logs, turning noise into meaningful insights.
 
-The following example demonstrates how to apply `grits` to `tcpdump` to extract a packet's source (`src`) and destination (`dst`) IP address:
+![demo gif](images/log.gif)
+
+<p align="center">
+  <em>An example of Grits in action: the left pane shows Grits being applied, and the right pane displays the raw logs.</em>
+</p>
+
+
+At its core, `grits` applies regular expressions with named captures to input lines. These captures are then available as variables
+(a.k.a. anchors) which can then be used in a `grits` template string. The template string supports text-alignment, colorization,
+as well as other attributes you'd expect using ANSI escape sequences.
+
+The following example demonstrates how to apply `grits` to `tcpdump` to extract an output line's timestamp (`ts`) and
+a packet's source (`src`) and destination (`dst`) IP address:
 
 ```bash
-sudo tcpdump -nn | grits -p '^(?<ts>[^ ]+)' \
+tcpdump -nn | grits -- \
+  -p '^(?<ts>[^ ]+)' \
   -p 'IP\w? (?<src>[^ ]+)' \
   -p '> (?<dst>[^ ]+):' \
-  -t '[{(cyan|bold):ts}] {(green|underlined):"src"}={src} {(yellow|underlined):"dst"}={dst}'
+  -t '[{(cyan|bold):ts}] {(green|underlined):"src"}={(lalign(45)):src} {(yellow|underlined):"dst"}={dst}'
 ```
 
 ![demo image](images/demo.png)
-The top pane in the above screenshot is the raw output of `tcpdump` while the bottom pane shows the output being piped into `grits`.
+<p align="center">
+  <em>The top pane in the above screenshot is the raw output of tcpdump while the bottom pane shows the output being piped into grits.</em>
+</p>